trunk/man/install_packages.8

.\"                                      Hey, EMACS: -*- nroff -*-
.if \n(zZ=1 .ig zZ
.if \n(zY=1 .ig zY
.TH install_packages 8 "23 march 2005" "FAI 2.7"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.de }1
.ds ]X \&\\*(]B\\
.nr )E 0
.if !"\\$1"" .nr )I \\$1n
.}f
.ll \\n(LLu
.in \\n()Ru+\\n(INu+\\n()Iu
.ti \\n(INu
.ie !\\n()Iu+\\n()Ru-\w\\*(]Xu-3p \{\\*(]X
.br\}
.el \\*(]X\h|\\n()Iu+\\n()Ru\c
.}f
..
.\"
.\" File Name macro.  This used to be `.PN', for Path Name,
.\" but Sun doesn't seem to like that very much.
.\"
.de FN
\fI\|\\$1\|\fP
..
.SH NAME
install_packages \- install FAI configured packages
.SH SYNOPSIS
.B install_packages
.SH DESCRIPTION
Fully Automatic Installation (FAI) is used to provide unattended installation of
Debian GNU/Linux operating systems with a very flexible class-based system.
install_packages is a Perl script written for FAI to selectively install, hold,
remove, or purge packages or tasks.

install_packages is called from the custom fai_rcS script and should not be
called directly.  It's function is to parse the package_config files based on
the class definitions of the client.  For example, if the client belonged to
the SMTPSERVER class, install_packages would parse ../package_config/SMTPSERVER
for instructions on what packages to install, hold, remove, or purge.

.SH OPTIONS
.TP
.B \-d
Only download packages instead of installing them. Variable
$aptoptions must be set.
.TP
.B \-f DIR
Read config file install_package.conf from DIR instead of
/etc/fai. Not needed any more.
.TP
.B \-h
Show help, version and summary of options.
.TP
.B \-l
Print only the list of all packages that would be installed, then exit.
.TP
.B \-L
Print the list of all packages with version number that would be installed, then exit.
.TP
.B \-m MAX
Install only MAX packages at a time
.TP
.BI "\-t "
Test mode. Do not execute installation commands.
.TP
.B \-v
Be verbose.


.SH NOTES
.PD 0
install_packages expects to find the FAI_ROOT directory, the location of class
definitions, package configurations, and custom install scripts, somewhere in
the filesystem.  This location is configurable in /etc/fai/fai.conf and defaults to
/usr/local/share/fai.
.PD
.SH SEE ALSO
.PD 0
This program is part of FAI (Fully Automatic Installation).  See the FAI manual
for more information on how to use install_packages.  The FAI homepage is
http://www.informatik.uni-koeln.de/fai.
.TP
\fIapt\fP(1), \fIapt-get\fP(8), \fIdpkg\fP(8), \fItasksel\fP(1)
.PD
.SH FILES
.PD 0
.TP
.FN /etc/fai/install_packages.conf
This configuration file must be in Perl syntax. Mostly used for
overriding the hash %command, the array @commands.

.TP
.FN /etc/fai/fai.conf
The FAI configuration file.

.TP
.FN /usr/local/share/fai/package_config/
The FAI package configuration directory.

.SH AUTHOR
Thomas Lange <lange@informatik.uni-koeln.de>
1	.\" Hey, EMACS: -- nroff --
2	.if \n(zZ=1 .ig zZ
3	.if \n(zY=1 .ig zY
4	.TH install_packages 8 "23 march 2005" "FAI 2.7"
5	.\" Please adjust this date whenever revising the manpage.
6	.\"
7	.\" Some roff macros, for reference:
8	.\" .nh disable hyphenation
9	.\" .hy enable hyphenation
10	.\" .ad l left justify
11	.\" .ad b justify to both left and right margins
12	.\" .nf disable filling
13	.\" .fi enable filling
14	.\" .br insert line break
15	.\" .sp <n> insert n+1 empty lines
16	.\" for manpage-specific macros, see man(7)
17	.de }1
18	.ds ]X \&\\*(]B\\
19	.nr )E 0
20	.if !"\\$1"" .nr )I \\$1n
21	.}f
22	.ll \\n(LLu
23	.in \\n()Ru+\\n(INu+\\n()Iu
24	.ti \\n(INu
25	.ie !\\n()Iu+\\n()Ru-\w\\(]Xu-3p \{\\(]X
26	.br\}
27	.el \\*(]X\h\|\\n()Iu+\\n()Ru\c
28	.}f
29	..
30	.\"
31	.\" File Name macro. This used to be `.PN', for Path Name,
32	.\" but Sun doesn't seem to like that very much.
33	.\"
34	.de FN
35	\fI\\|\\$1\\|\fP
36	..
37	.SH NAME
38	install_packages \- install FAI configured packages
39	.SH SYNOPSIS
40	.B install_packages
41	.SH DESCRIPTION
42	Fully Automatic Installation (FAI) is used to provide unattended installation of
43	Debian GNU/Linux operating systems with a very flexible class-based system.
44	install_packages is a Perl script written for FAI to selectively install, hold,
45	remove, or purge packages or tasks.
46
47	install_packages is called from the custom fai_rcS script and should not be
48	called directly. It's function is to parse the package_config files based on
49	the class definitions of the client. For example, if the client belonged to
50	the SMTPSERVER class, install_packages would parse ../package_config/SMTPSERVER
51	for instructions on what packages to install, hold, remove, or purge.
52
53	.SH OPTIONS
54	.TP
55	.B \-d
56	Only download packages instead of installing them. Variable
57	$aptoptions must be set.
58	.TP
59	.B \-f DIR
60	Read config file install_package.conf from DIR instead of
61	/etc/fai. Not needed any more.
62	.TP
63	.B \-h
64	Show help, version and summary of options.
65	.TP
66	.B \-l
67	Print only the list of all packages that would be installed, then exit.
68	.TP
69	.B \-L
70	Print the list of all packages with version number that would be installed, then exit.
71	.TP
72	.B \-m MAX
73	Install only MAX packages at a time
74	.TP
75	.BI "\-t "
76	Test mode. Do not execute installation commands.
77	.TP
78	.B \-v
79	Be verbose.
80
81
82	.SH NOTES
83	.PD 0
84	install_packages expects to find the FAI_ROOT directory, the location of class
85	definitions, package configurations, and custom install scripts, somewhere in
86	the filesystem. This location is configurable in /etc/fai/fai.conf and defaults to
87	/usr/local/share/fai.
88	.PD
89	.SH SEE ALSO
90	.PD 0
91	This program is part of FAI (Fully Automatic Installation). See the FAI manual
92	for more information on how to use install_packages. The FAI homepage is
93	http://www.informatik.uni-koeln.de/fai.
94	.TP
95	\fIapt\fP(1), \fIapt-get\fP(8), \fIdpkg\fP(8), \fItasksel\fP(1)
96	.PD
97	.SH FILES
98	.PD 0
99	.TP
100	.FN /etc/fai/install_packages.conf
101	This configuration file must be in Perl syntax. Mostly used for
102	overriding the hash %command, the array @commands.
103
104	.TP
105	.FN /etc/fai/fai.conf
106	The FAI configuration file.
107
108	.TP
109	.FN /usr/local/share/fai/package_config/
110	The FAI package configuration directory.
111
112	.SH AUTHOR
113	Thomas Lange <lange@informatik.uni-koeln.de>
Name	Value
svn:eol-style	native
svn:keywords	Author Date Id Revision