Added man page.

diff --git a/apps/autodist/CHANGES b/apps/autodist/CHANGES
index b9fe82d048c3f7702bf46f7c6e8080a161e7450c..7b9836b40c9a21a76a0b6c3f359c3b7b81b0958b 100644 (file)
--- a/apps/autodist/CHANGES
+++ b/apps/autodist/CHANGES
@@ -4,6 +4,8 @@ Sun Apr 17 20:08:28 EEST 2005  Pekka Riikonen <priikone@silcnet.org>
 
        * Added pre-process-dist-hook and post-process-dist-hook.
 
+       * Added autodist.1.
+
 Sun Apr 16 23:00:02 EEST 2005  Pekka Riikonen <priikone@silcnet.org>
 
        * First release, Autodist 1.0.

diff --git a/apps/autodist/configure.ad b/apps/autodist/configure.ad
index 806ac54fdce464a02ea17d54aedec1dba59d88ae..3f2d1f7244197b2804ef196b617e8779ea65ba05 100644 (file)
--- a/apps/autodist/configure.ad
+++ b/apps/autodist/configure.ad
@@ -47,6 +47,7 @@ apps/autodist/Makefile
 apps/autodist/autodist
 apps/autodist/makedist
 apps/autodist/doc/Makefile
+apps/autodist/doc/autodist.1
 apps/autodist/tests/Makefile
 )
 #endif SILC_DIST_AUTODIST

diff --git a/apps/autodist/doc/Makefile.am b/apps/autodist/doc/Makefile.am
index 2ffb4b0c40c4bc24d57aa22283a2c18d7ffe768f..003c074433f42a9ca42105636bbf52a3f46be5e4 100644 (file)
--- a/apps/autodist/doc/Makefile.am
+++ b/apps/autodist/doc/Makefile.am
@@ -17,3 +17,6 @@
 
 info_TEXINFOS = autodist.texi
 autodist_TEXINFOS = fdl.texi
+
+man_MANS = autodist.1
+EXTRA_DIST = $(man_MANS)

diff --git a/apps/autodist/doc/autodist.1.in b/apps/autodist/doc/autodist.1.in
new file mode 100644 (file)
index 0000000..333ccb3
--- /dev/null
+++ b/apps/autodist/doc/autodist.1.in
@@ -0,0 +1,98 @@
+.TH AUTODIST "1" "April 2005" "@PACKAGE_NAME@ @VERSION@" "User Commands"
+.SH NAME
+Autodist \- Source distribution management system
+.SH SYNOPSIS
+.B autodist
+[options] [distribution] [version]
+.PP
+.SH DESCRIPTION
+.PP
+The Autodist is a source distribution management system that allows 
+powerful mechanisms to define what is included in and excluded from a 
+distribution, and what license the distribution is released under.  It is 
+also used to create the actual distribution source packages.  Autodist 
+allows distribution management in file, directory and file content level.  
+Different distributions may include different portions of files, for 
+example, excluding certain features from certain distributions.  It is 
+always guaranteed that anything not defined for the distribution, is 
+removed automatically (files, file content, directories), thus ensuring 
+that nothing is accidentally included in the distribution.
+.PP
+Autodist is closely related to the Autoconf and Automake tools, and 
+complements the features Autoconf and Automake provides.  It is especially 
+targeted into circumstances where multiple distributions are created from 
+one source tree.  The Autoconf and Automake environment is mainly designed 
+for one application per one source tree situations.  Autodist provides 
+mechanisms to create all kinds of distributions that can be created from 
+one source tree.  To be able to use Autodist, the Autoconf and Automake 
+must be installed into the system.
+.PP
+.SH OPTIONS
+.B Operation modes:
+.PP
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Prints the help for the Autodist and exits.
+.PP
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Prints version number and exits.
+.PP
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Verbosely report processing.
+.PP
+.TP
+\fB\-d\fR, \fB\-\-distdir\fR
+Search distributions from <dir> instead of default 'distdir'.
+.PP
+.TP
+\fB\-s\fR, \fB\-\-distdefs\fR \fB[<dist>]\fR
+Prints distribution defines of <dist> and exits.
+.PP
+.TP
+\fB\-i\fR, \fB\-\-init\fR
+Initializes Autodist environment.  Creates the default distribution
+directory 'distdir', 'autodist.conf' configuration file and the
+default distribution 'default', then exits.
+.PP
+.TP
+\fB\-m\fR, \fB\-\-makedist\fR
+Creates and packages distribution
+.PP
+.TP
+\fB\-\-gzip\fR
+Create package compressed with gzip (default)
+.PP
+.TP
+\fB\-\-bzip2\fR
+Create also package compressed with bzip2
+.PP
+.TP
+\fB\-\-compress\fR
+Create also package compressed with compress
+.PP
+.TP
+\fB\-\-zip\fR
+Create also package compressed with zip
+.SH COPYRIGHT
+Copyright \(co 2005 Pekka Riikonen, SILC Project
+.br
+This is free software; see the source for copying conditions.  There is NO
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+PURPOSE.
+.SH "SEE ALSO"
+.BR autoconf (1),
+.BR automake (1),
+.PP
+The full documentation for
+.B autodist
+is maintained as a Texinfo manual.  If the
+.B info
+and
+.B autodist
+programs are properly installed at your site, the command
+.IP
+.B info autodist
+.PP
+should give you access to the complete manual.

diff --git a/apps/autodist/doc/autodist.texi b/apps/autodist/doc/autodist.texi
index dc1190b3411af6af39284d86b771acf75ebd1d02..d0792a6707c5ef919bb2a7ec71a76084024d588c 100644 (file)
--- a/apps/autodist/doc/autodist.texi
+++ b/apps/autodist/doc/autodist.texi
@@ -1090,13 +1090,14 @@ a compiler friendly format, defined below, should be used.
 #endif /* SILC_DIST_DEFINE */
 @end example
 
-Note that, only the format defined above is supported.  Other more complex
-use of the preprocessor directives such as using '&&' and '||' in the '#ifdef'
-or '#ifndef' are not supported, and neither is '#elif'.  Also note, that in
-the compiler friendly format the name of the distdef in comments and the
-use of '!' character in the '#else' branch of '#ifdef' are mandatory.  Also
-note, that the distdef conditionals must be placed at the start of the line,
-they must not be indented.
+Note that, only the format defined above is supported.  Other more complex 
+use of the preprocessor directives such as using '&&' and '||' in the 
+'#ifdef' or '#ifndef' are not supported, and neither is '#elif'.  Also 
+note, that the name of the distdef in '#else' and '#ifdef' directives in 
+non-source format and in source format inside C comments (/* */), and the 
+use of '!' character in the '#else' branch of '#ifdef'" are mandatory.  
+Also note, that the distdef conditionals must be placed at the start of 
+the line, they must not be indented.
 
 The following example shows the use of non-source format:
 
@@ -1538,6 +1539,7 @@ undef _DIST_CRYPTO
 
 @example
 # Common template
+option template
 define _DIST_DOC
 define _DIST_LIB
 define _DIST_MATH