From d282bc462578a6e47747c78d2d42883530f0d11e Mon Sep 17 00:00:00 2001 From: Mark Griffiths Date: Fri, 1 Aug 2014 03:37:32 +0100 Subject: Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options. --- doc_src/psub.txt | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) (limited to 'doc_src/psub.txt') diff --git a/doc_src/psub.txt b/doc_src/psub.txt index 7f4dbedd..62c09be0 100644 --- a/doc_src/psub.txt +++ b/doc_src/psub.txt @@ -1,7 +1,9 @@ \section psub psub - perform process substitution \subsection psub-synopsis Synopsis - COMMAND1 (COMMAND2|psub [-f]) +\fish{syn} +COMMAND1 (COMMAND2|psub [-f]) +\endfish \subsection psub-description Description @@ -11,16 +13,16 @@ send the output of a command into the calling command, much like command substitution, but with the difference that the output is not sent through commandline arguments but through a named pipe, with the filename of the named pipe sent as an argument to the calling -program. \c psub combined with a +program. `psub` combined with a regular command substitution provides the same functionality. -If the \c -f or \c --file switch is given to psub, \c psub will use a +If the `-f` or `--file` switch is given to `psub`, `psub` will use a regular file instead of a named pipe to communicate with the calling -process. This will cause \c psub to be significantly slower when large +process. This will cause `psub` to be significantly slower when large amounts of data are involved, but has the advantage that the reading process can seek in the stream. \subsection psub-example Example -diff (sort a.txt|psub) (sort b.txt|psub) shows the difference +`diff (sort a.txt|psub) (sort b.txt|psub)` shows the difference between the sorted versions of files a.txt and b.txt. -- cgit v1.2.3