Make the fish manpage in Doxygen and add it to the main fish documentation

darcs-hash:20061026102059-ac50b-2a7956bb4651b5ffe867e7c6eb26a29e2f15ad24.gz

Makefile.in

@@ -114,12 +114,12 @@ BUILTIN_DOC_HDR := $(BUILTIN_DOC_SRC:.txt=.doxygen)
 # Files containing documentation for external commands. 
 #
 CMD_DOC_SRC := doc_src/contains.txt doc_src/count.txt doc_src/dirh.txt	\
-	doc_src/dirs.txt doc_src/fish_pager.txt doc_src/fishd.txt			\
+	doc_src/dirs.txt doc_src/fish.txt doc_src/fish_pager.txt			\
-	doc_src/help.txt doc_src/isatty.txt doc_src/mimedb.txt				\
+	doc_src/fishd.txt doc_src/help.txt doc_src/isatty.txt				\
-	doc_src/nextd.txt doc_src/open.txt doc_src/popd.txt					\
+	doc_src/mimedb.txt doc_src/nextd.txt doc_src/open.txt				\
-	doc_src/prevd.txt doc_src/psub.txt doc_src/pushd.txt				\
+	doc_src/popd.txt doc_src/prevd.txt doc_src/psub.txt					\
-	doc_src/set_color.txt doc_src/trap.txt doc_src/type.txt				\
+	doc_src/pushd.txt doc_src/set_color.txt doc_src/trap.txt			\
-	doc_src/umask.txt doc_src/vared.txt
+	doc_src/type.txt doc_src/umask.txt doc_src/vared.txt
 
 #
 # Files generated by running doxygen on the files in $(CMD_DOC_SRC)
@@ -137,7 +137,7 @@ TEST_IN := $(wildcard tests/test*.in)
 
 # Files in ./doc_src/
 DOC_SRC_DIR_FILES := doc_src/Doxyfile.in doc_src/doc.hdr	\
-	$(BUILTIN_DOC_SRC) $(CMD_DOC_SRC) doc_src/fish.1.in
+	$(BUILTIN_DOC_SRC) $(CMD_DOC_SRC) 
 
 # Files in ./
 MAIN_DIR_FILES := Doxyfile Doxyfile.user Makefile.in configure		\
@@ -170,11 +170,11 @@ FUNCTIONS_DIR_FILES := $(wildcard share/functions/*.fish)
 PROGRAMS:=fish set_color @XSEL@ @SEQ_FALLBACK@ mimedb count fish_pager fishd
 
 # Manuals to install
-MANUALS:=doc_src/fish.1 @XSEL_MAN_PATH@			\
+MANUALS:=doc_src/builtin_doc/man/man1/fish.1 @XSEL_MAN_PATH@	\
-	doc_src/builtin_doc/man/man1/mimedb.1		\
+	doc_src/builtin_doc/man/man1/mimedb.1						\
-	doc_src/builtin_doc/man/man1/set_color.1	\
+	doc_src/builtin_doc/man/man1/set_color.1					\
-	doc_src/builtin_doc/man/man1/count.1 \
+	doc_src/builtin_doc/man/man1/count.1						\
-	doc_src/builtin_doc/man/man1/fishd.1 \
+	doc_src/builtin_doc/man/man1/fishd.1						\
 	doc_src/builtin_doc/man/man1/fish_pager.1
 
 #All translation message catalogs
@@ -201,7 +201,7 @@ debug:
 .PHONY: debug
 
 # User documentation, describing the features of the fish shell.
-user_doc: doc_src/doc.hdr Doxyfile.user user_doc.head.html
+user_doc: doc_src/doc.hdr Doxyfile.user user_doc.head.html $(CMD_DOC_SRC) $(BUILTIN_DOC_SRC)
 	$(MAKE) doc.h # Depend on the source (doc.hdr) and manually make the intermediate as needed
 	doxygen Doxyfile.user
 	touch user_doc
@@ -240,8 +240,8 @@ doc.h:$(BUILTIN_DOC_SRC) $(CMD_DOC_SRC) doc_src/doc.hdr
 		cat $$i >>doc.h; \
 	done 
 	echo "*/" >>doc.h
-	echo "/** \page commands External commands" >>doc.h; 
+	echo "/** \page commands External commands and functions" >>doc.h; 
-	echo "\c fish is shipped with commands which do not use any internal parts of the shell, and are therefore not written as builtins, but separate commands." >>doc.h
+	echo "\c fish is shipped with commands which do not use any internal parts of the shell, and are therefore not written as builtins, but separate commands. Fish also features a large number of shellscript functions." >>doc.h
 	for i in `printf "%s\n" $(CMD_DOC_SRC)|sort`; do \
 		echo "<hr>" >>doc.h; \
 		cat $$i >>doc.h; \
@@ -619,7 +619,7 @@ rpm: fish-@PACKAGE_VERSION@.tar.bz2 fish.spec
 #
 
 distclean: clean
-	rm -f fish.spec doc_src/fish.1 doc_src/Doxyfile 
+	rm -f fish.spec doc_src/Doxyfile 
 	rm -f etc/fish etc/fish_interactive.fish seq share/fish
 	rm -f config.status config.log config.h Makefile
 .PHONY: distclean

builtin.c

@@ -13,7 +13,7 @@
 
 	3). Create a file doc_src/NAME.txt, containing the manual for the builtin in Doxygen-format. Check the other builtin manuals for proper syntax.
 
-	4). Add an entry to the BUILTIN_DOC_SRC variable of Makefile.in. Note that the entries should be sorted alphabetically!
+	4). Add an entry to the BUILTIN_DOC_SRC variable of Makefile.in.
 
 	5). Add an entry to the manual at the builtin-overview subsection of doc_src/doc.hdr. Note that the entries should be sorted alphabetically!
 

configure.ac

@@ -649,7 +649,7 @@ case $target_os in
 esac
 
 # Tell the world what we know
-AC_CONFIG_FILES([Makefile fish.spec doc_src/fish.1 doc_src/Doxyfile seq])
+AC_CONFIG_FILES([Makefile fish.spec doc_src/Doxyfile seq])
 AC_OUTPUT
 
 if test ! x$local_found_posix_switch = xyes; then

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
+