From 0f5b2629a6543c5633d429334008ecada7c3c305 Mon Sep 17 00:00:00 2001 From: Pekka Riikonen Date: Sun, 17 Apr 2005 23:08:59 +0000 Subject: [PATCH] Added man page. --- apps/autodist/CHANGES | 2 + apps/autodist/configure.ad | 1 + apps/autodist/doc/Makefile.am | 3 + apps/autodist/doc/autodist.1.in | 98 +++++++++++++++++++++++++++++++++ apps/autodist/doc/autodist.texi | 16 +++--- 5 files changed, 113 insertions(+), 7 deletions(-) create mode 100644 apps/autodist/doc/autodist.1.in diff --git a/apps/autodist/CHANGES b/apps/autodist/CHANGES index b9fe82d..7b9836b 100644 --- a/apps/autodist/CHANGES +++ b/apps/autodist/CHANGES @@ -4,6 +4,8 @@ Sun Apr 17 20:08:28 EEST 2005 Pekka Riikonen * Added pre-process-dist-hook and post-process-dist-hook. + * Added autodist.1. + Sun Apr 16 23:00:02 EEST 2005 Pekka Riikonen * First release, Autodist 1.0. diff --git a/apps/autodist/configure.ad b/apps/autodist/configure.ad index 806ac54..3f2d1f7 100644 --- 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 2ffb4b0..003c074 100644 --- 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 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 instead of default 'distdir'. +.PP +.TP +\fB\-s\fR, \fB\-\-distdefs\fR \fB[]\fR +Prints distribution defines of 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 dc1190b..d0792a6 100644 --- 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 -- 2.24.0