5d877bad1a54ec49892d0f041f38296bc148bcd1
[autodist.git] / apps / autodist / doc / autodist.1.in
1 .TH AUTODIST "1" "April 2005" "@PACKAGE_NAME@ @VERSION@" "User Commands"
2 .SH NAME
3 Autodist \- Source distribution management system
4 .SH SYNOPSIS
5 .B autodist
6 [options] [distribution] [version] [params]
7 .PP
8 .SH DESCRIPTION
9 .PP
10 The Autodist is a source distribution management system that allows 
11 powerful mechanisms to define what is included in and excluded from a 
12 distribution, and what license the distribution is released under.  It is 
13 also used to create the actual distribution source packages.  Autodist 
14 allows distribution management in file, directory and file content level.  
15 Different distributions may include different portions of files, for 
16 example, excluding certain features from certain distributions.  It is 
17 always guaranteed that anything not defined for the distribution, is 
18 removed automatically (files, file content, directories), thus ensuring 
19 that nothing is accidentally included in the distribution.
20 .PP
21 Autodist is closely related to the Autoconf and Automake tools, and 
22 complements the features Autoconf and Automake provides.  It is especially 
23 targeted into circumstances where multiple distributions are created from 
24 one source tree.  The Autoconf and Automake environment is mainly designed 
25 for one application per one source tree situations.  Autodist provides 
26 mechanisms to create all kinds of distributions that can be created from 
27 one source tree.  To be able to use Autodist, the Autoconf and Automake 
28 must be installed into the system.
29 .PP
30 .SH OPTIONS
31 .B Operation modes:
32 .PP
33 .TP
34 \fB\-h\fR, \fB\-\-help\fR
35 Prints the help for the Autodist and exits.
36 .PP
37 .TP
38 \fB\-V\fR, \fB\-\-version\fR
39 Prints version number and exits.
40 .PP
41 .TP
42 \fB\-v\fR, \fB\-\-verbose\fR
43 Verbosely report processing.
44 .PP
45 .TP
46 \fB\-d\fR, \fB\-\-distdir\fR
47 Search distributions from <dir> instead of default 'distdir'.
48 .PP
49 .TP
50 \fB\-s\fR, \fB\-\-distdefs\fR \fB[<dist>]\fR
51 Prints distribution defines of <dist> and exits.
52 .PP
53 .TP
54 \fB\-i\fR, \fB\-\-init\fR
55 Initializes Autodist environment.  Creates the default distribution
56 directory 'distdir', 'autodist.conf' configuration file and the
57 default distribution 'default', then exits.
58 .PP
59 .TP
60 \fB\-p\fR, \fB\-\-process\fR \fB<type>\fR \fB<src>\fR \fB<dst>\fR
61 Process file <src> into <dst> for distribution, <type> is 'makefile', 
62 'configure', 'non-source' or 'source' and defines the type of <src>.
63 .PP
64 .TP
65 \fB\-m\fR, \fB\-\-makedist\fR
66 Creates and packages distribution
67 .PP
68 .TP
69 \fB\-\-gzip\fR
70 Create package compressed with gzip (default)
71 .PP
72 .TP
73 \fB\-\-bzip2\fR
74 Create also package compressed with bzip2
75 .PP
76 .TP
77 \fB\-\-compress\fR
78 Create also package compressed with compress
79 .PP
80 .TP
81 \fB\-\-zip\fR
82 Create also package compressed with zip
83 .SH COPYRIGHT
84 Copyright \(co 2005 Pekka Riikonen, SILC Project
85 .br
86 This is free software; see the source for copying conditions.  There is NO
87 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR 
88 PURPOSE.
89 .SH "SEE ALSO"
90 .BR autoconf (1),
91 .BR automake (1),
92 .PP
93 The full documentation for
94 .B autodist
95 is maintained as a Texinfo manual.  If the
96 .B info
97 and
98 .B autodist
99 programs are properly installed at your site, the command
100 .IP
101 .B info autodist
102 .PP
103 should give you access to the complete manual.