diff --git a/Makefile.in b/Makefile.in index 0e874a452..956d618ce 100644 --- a/Makefile.in +++ b/Makefile.in @@ -100,9 +100,10 @@ BUILTIN_DOC_HDR := $(BUILTIN_DOC_SRC:.txt=.doxygen) # CMD_DOC_SRC := doc_src/count.txt doc_src/dirh.txt doc_src/dirs.txt \ - doc_src/help.txt doc_src/mimedb.txt doc_src/nextd.txt \ - doc_src/open.txt doc_src/popd.txt doc_src/prevd.txt \ - doc_src/pushd.txt doc_src/set_color.txt doc_src/tokenize.txt + doc_src/fishd.txt doc_src/help.txt doc_src/mimedb.txt \ + doc_src/nextd.txt doc_src/open.txt doc_src/popd.txt \ + doc_src/prevd.txt doc_src/pushd.txt doc_src/set_color.txt \ + doc_src/tokenize.txt # # Files generated by running doxygen on the files in $(CMD_DOC_SRC) diff --git a/doc_src/fishd.txt b/doc_src/fishd.txt index 1ffdca95b..ebdabd3f3 100644 --- a/doc_src/fishd.txt +++ b/doc_src/fishd.txt @@ -13,7 +13,35 @@ fishd instance. fishd will create a socket in /tmp, and wait for incoming connections from universal variable clents, such as fish, When no clients are connected, fishd will automatically shut down. +\subsection fishd-commands Commands + +Fishd works by sending and recieving sommands. Each command is ended +with a newline. These are the commands supported by fishd: + +
set KEY:VALUE
+set_export KEY:VALUE
+
+ +These commands update the value of a variable. The only difference +between the two is that set_export-variables should be +exported to children of the process using them. The variable value may +be escaped using C-style backslash escapes. In fact, this is required +for newline characters, which would otherwise be interpreted as end of +command. + +
erase KEY
+
+ +Erase the variable with the specified name. + +
barrier
+barrier_reply
+
+ +A \c barrier command will result in a barrier_reply beeing added to +the end of the senders queue. These commands are used to synchronize +clients. \subecion fishd-files Files -~/.fishd permenent storage location for universal variale data +~/.fishd.HOSTNAME permenent storage location for universal variale data