From ce0e31ab864cecfe357f1560ec425569af1ea919 Mon Sep 17 00:00:00 2001 From: Dieter Plaetinck Date: Fri, 22 May 2009 21:26:46 +0200 Subject: cleanup of (old/outdated) docs --- docs/config-syntax | 45 +++++---------------------------------------- 1 file changed, 5 insertions(+), 40 deletions(-) (limited to 'docs/config-syntax') diff --git a/docs/config-syntax b/docs/config-syntax index 30cf91f..9894401 100644 --- a/docs/config-syntax +++ b/docs/config-syntax @@ -1,42 +1,5 @@ -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. - +here: design notes +readme: end-user instructions Rationale. AKA "why not config files?" @@ -53,4 +16,6 @@ issues - iterate over state structs and generate appropriate commands to bring an instance in this state. - plaintext :) - user editable - - also useful for saving state if we need to update/shutdown/.. \ No newline at end of file + - also useful for saving state if we need to update/shutdown/.. + -> all of this is overkill. for now we just decided to live with the fact we pass on '--config' flags, + it's up to the user to tweak his setup so it works. -- cgit v1.2.3