From 8d714bb94fc900cee4fa91048e5c91a67e66a224 Mon Sep 17 00:00:00 2001 From: Dieter Plaetinck Date: Sat, 9 May 2009 16:03:44 +0200 Subject: first draft of new config spec --- docs/config-syntax | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 docs/config-syntax (limited to 'docs/config-syntax') 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 -c + +Lines written to the above starting with '#' or being empty, are ignored. + +** Command syntax: +commands can have no, one or 2 arguments. + +[\t[\t]] + +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 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 +script +script_file +back +forward +scroll_vert +scroll_horz +reload +reload_ign_cache +stop +zoom_in +zoom_out +spawn +exit +search + +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 -- cgit v1.2.3