first draft of new config spec

1 files changed, 38 insertions, 0 deletions

diff --git a/docs/config-syntax b/docs/config-syntax
new file mode 100644
index 0000000..2315b6c
--- /dev/null
+++ b/docs/config-syntax
@@ -0,0 +1,38 @@
+Configuration setting at startup and changing at runtime happens through one of these:
+- stdin at startup (TODO: see if we can keep listening while running) (write command to it + "\n")
+- fifo (write command to it + "\n")
+- socket (uzblctrl -s <file> -c <comand>
+
+Lines written to the above starting with '#' or being empty, are ignored.
+
+** Command syntax:
+commands can have no, one or 2 arguments.
+
+<command>[\t<arg1>[\t<arg2>]]
+
+The 'bind' command is a special command, where argument 1 is a keyboard character (combo) and argument 2 is a command as specified above.
+You can also use a '_' in the <chars> part to denote where you pass on whatever you want, which will be replaced into the specififed command whereever %s is mentioned
+
+** commands
+Commands where one of the arguments is "parameter" expect this arugment to be a valid variable identifier (eg uzbl.behave.status_format) 
+
+set              parameter value # make sure the value complies with the datatype.
+toggle           parameter    # expects parameter to be a gboolean. (eg status, insert_mode, ..)
+get              parameter
+bind             <chars> <command>
+script           <JS code to execute>
+script_file      <filename containing JS code to execute>
+back
+forward
+scroll_vert      <int>
+scroll_horz      <int>
+reload
+reload_ign_cache
+stop
+zoom_in
+zoom_out
+spawn            <filename for process to start asynchronously>
+exit
+search           <string>
+
+The 'set' command may do more then just set the variable. eg 'set uri' commands will also cause uzbl to navigate to the uri.
\ No newline at end of file