aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/fish.txt
diff options
context:
space:
mode:
authorGravatar axel <axel@liljencrantz.se>2006-10-26 20:20:59 +1000
committerGravatar axel <axel@liljencrantz.se>2006-10-26 20:20:59 +1000
commit3341fc888c9b008b6b83603406755610b83f2c94 (patch)
tree4138b8c6268a1d84065a8319f00d93cb9895531f /doc_src/fish.txt
parent1faf7df371e229f696926069f41fb34cf17b16bd (diff)
Make the fish manpage in Doxygen and add it to the main fish documentation
darcs-hash:20061026102059-ac50b-2a7956bb4651b5ffe867e7c6eb26a29e2f15ad24.gz
Diffstat (limited to 'doc_src/fish.txt')
-rw-r--r--doc_src/fish.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc_src/fish.txt b/doc_src/fish.txt
new file mode 100644
index 00000000..5c350146
--- /dev/null
+++ b/doc_src/fish.txt
@@ -0,0 +1,18 @@
+\section fish fish - The friendly interactive shell
+
+\subsection fish-synopsis Synopsis
+fish [-h] [-v] [-c command] [FILE [ARGUMENTS...]]
+
+\subsection fish-description Description
+
+A commandline shell written mainly with interactive use in mind. The full manual is available <a href='index.html'>in html</a> by using the <a href='#help'>help</a> command from inside fish.
+
+- <code>-c</code> or <code>--command=COMMANDS</code> evaluate the specified commands instead of reading from the commandline
+- <code>-d</code> or <code>--debug-level=DEBUG_LEVEL</code> specify the verbosity level of fish. A higher number means higher verbosity. The default level is 1.
+- <code>-h</code> or <code>--help</code> display help and exit
+- <code>-i</code> or <code>--interactive</code> specify that fish is to run in interactive mode
+- <code>-l</code> or <code>--login</code> specify that fish is to run as a login shell
+- <code>-n</code> or <code>--no-execute</code> do not execute any commands, only perform syntax checking
+- <code>-p</code> or <code>--profile=PROFILE_FILE</code> when fish exits, output timing information on all executed commands to the specified file
+- <code>-v</code> or <code>--version</code> display version and exit
+