h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-06-01 04:41:14 -03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation update

Browse Source 
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.
This commit is contained in:
Mark Griffiths
2014-08-01 03:37:32 +01:00
parent 1c4223889b
commit d282bc4625
86 changed files with 9212 additions and 4813 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc_src/psub.txt
View File

@@ -1,7 +1,9 @@
\section psub psub - perform process substitution
\subsection psub-synopsis Synopsis
<tt>COMMAND1 (COMMAND2|psub [-f]) </tt>
\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 <tt>psub</tt>, \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
<tt>diff (sort a.txt|psub) (sort b.txt|psub)</tt> 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.