Conkeror RC
Your rc is your own script or scripts loaded at startup that you can use to configure Conkeror. The abbreviation rc is derived from the tradition of naming startup scripts with the suffix rc in unix-like platforms. Your conkeror-rc is written in ordinary javascript. You can use it to define key bindings, define new commands, set preferences, set user-variables, configure extensions, and much more.
RC File Location
The default location of the rc is .conkerorrc in your home directory. This can be changed by setting the preference conkeror.rcfile. The rc can be an ordinary file or a directory. If it is an ordinary file, Conkeror will evaluate that file as javascript. If it is a directory, Conkeror will evaluate all files in that directory that have the .js file extension.
You change your rc by doing:
M-: user_pref('conkeror.rcfile', '/home/foo/conkeror-rc'); RETor from the command line:
conkeror -q -batch -e "user_pref('conkeror.rcfile', '/home/foo/conkeror-rc');"If conkeror.rcfile is set to the empty string, Conkeror will not attempt to load any rc.
Note: due to a current limitation in Conkeror's script loading code, you cannot use ~ notation for home directory when your rc is a file. Use a full path until further notification.
Syntax
Your rc file is a JavaScript file. You can set user variables just as you would assign any other variable in JavaScript:
variable_name = value;
You can set user and session preferences (not be confused with user variables) using the user_pref and session_pref functions, e.g.:
session_pref("preference_name", value);
Debugging
When debugging your rc file remember you can use the dumpln function to print arbitrary strings. Also remember that if you execute conkeror from a command line, it will show you any syntax or other errors in your rc file.
Attn: Windows users
Set your rc with a native Windows-style path with drive letter and backslash separators. If you set your rc with the M-: method above, you will need to double up the backslashes because backslash is the character-escape character in javascript strings. Your path would look like c:\\path\\to\\conkeror-rc.
FIXME: What about the command-line method under Windows? How many backslashes are needed to pass a backslash through both the command shell and javascript?