mirror of
https://github.com/fish-shell/fish-shell
synced 2025-01-13 05:28:49 +00:00
Documentation updates
darcs-hash:20050923144445-ac50b-851b042248bd0d4f857c0cb744393ed16c13a95d.gz
This commit is contained in:
parent
5f546e1c4c
commit
a6b10d28eb
2 changed files with 33 additions and 4 deletions
|
@ -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)
|
||||
|
|
|
@ -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:
|
||||
|
||||
<pre>set KEY:VALUE
|
||||
set_export KEY:VALUE
|
||||
</pre>
|
||||
|
||||
These commands update the value of a variable. The only difference
|
||||
between the two is that <tt>set_export</tt>-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.
|
||||
|
||||
<pre>erase KEY
|
||||
</pre>
|
||||
|
||||
Erase the variable with the specified name.
|
||||
|
||||
<pre>barrier
|
||||
barrier_reply
|
||||
</pre>
|
||||
|
||||
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
|
||||
|
|
Loading…
Reference in a new issue