lix-project/lix
20
57
Fork 31
Code Issues 344 Code Review (Gerrit) Projects 3 Releases Wiki Activity

* Generate man pages from the manual.

Browse source
This commit is contained in:
Eelco Dolstra 2003-08-12 13:54:42 +00:00
parent c602930e08
commit e405ca506e
6 changed files with 92 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
Makefile.am
View file

@ -1,3 +1,3 @@
SUBDIRS = externals src scripts corepkgs
SUBDIRS = externals src scripts corepkgs doc
EXTRA_DIST = boost/*.hpp boost/format/*.hpp substitute.mk

3
configure.ac
View file

@ -18,5 +18,6 @@ AC_CHECK_LIB(pthread, pthread_mutex_init)
AM_CONFIG_HEADER([config.h])
AC_CONFIG_FILES([Makefile externals/Makefile src/Makefile scripts/Makefile
corepkgs/Makefile corepkgs/fetchurl/Makefile
corepkgs/nar/Makefile])
corepkgs/nar/Makefile
doc/Makefile doc/manual/Makefile])
AC_OUTPUT

1
doc/Makefile.am Normal file
View file

@ -0,0 +1 @@
SUBDIRS = manual

11
doc/manual/Makefile
View file

@ -1,11 +0,0 @@
DOCBOOK_DTD = /nix/current/xml/dtd/docbook
DOCBOOK_XSL = /nix/current/xml/xsl/docbook
all: check html
check:
SP_CHARSET_FIXED=YES SP_ENCODING=XML \
nsgmls -wxml -c /usr/share/doc/packages/sp/html-xml/xml.soc -c $(DOCBOOK_DTD)/docbook.cat -ges book.xml
html:
xsltproc --output book.html $(DOCBOOK_XSL)/html/docbook.xsl book.xml

22
doc/manual/Makefile.am Normal file
View file

@ -0,0 +1,22 @@
DOCBOOK_DTD = /nix/current/xml/dtd/docbook
DOCBOOK_XSL = /nix/current/xml/xsl/docbook
XML = /usr/share/doc/packages/sp/html-xml/xml.soc
%.is-valid: %.xml
SP_CHARSET_FIXED=YES SP_ENCODING=XML \
nsgmls -wxml -c $(XML) -c $(DOCBOOK_DTD)/docbook.cat -ges $<
touch $@
man1_MANS = nix.1
man nix.1: book.is-valid
xsltproc $(DOCBOOK_XSL)/manpages/docbook.xsl book.xml
%.html: %.xml %.is-valid
xsltproc --output book.html $(DOCBOOK_XSL)/html/docbook.xsl book.xml
all-local: book.html
install-data-local: book.html
$(INSTALL) -d $(datadir)/nix/manual
$(INSTALL_DATA) book.html $(datadir)/nix/manual

67
doc/manual/book.xml
View file

@ -216,6 +216,71 @@ $ make install</screen>
</chapter>
<!--======================================================================-->
<appendix>
<title>Command Reference</title>
<refentry>
<refnamediv>
<refname>nix</refname>
<refpurpose>manipulate or query the Nix store</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>nix</command>
<arg>--verbose</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The command <command>nix</command> provides access to the Nix store.
This is the (set of) path(s) where Nix expressions and the file
system objects built by them are stored.
</para>
</refsect1>
<refsect1>
<title>Common Options</title>
<para>
<command>nix</command> has many subcommands. These are listed below.
In this section the common options are listed. These options are
allowed for every subcommand (although they may not always have an
effect).
</para>
</refsect1>
<refsect1>
<title>Subcommand <command>--install</command></title>
<refsect2>
<title>Synopsis</title>
<cmdsynopsis>
<command>nix --install</command>
<arg rep='repeat'><replaceable>id</replaceable></arg>
</cmdsynopsis>
</refsect2>
<refsect2>
<title>Description</title>
<para>
<command>nix --install</command> realises the given Nix expressions
in the file system.
</para>
</refsect2>
</refsect1>
</refentry>
</appendix>
<!--======================================================================-->
<appendix>
@ -267,7 +332,7 @@ $ rm `db_archive -a -h <replaceable>prefix</replaceable>/var/nix/db`</screen>
<!--======================================================================-->
<appendix>
<title>Known problems</title>
<title>Bugs</title>
<itemizedlist>