[apt-legacy.git] / doc / apt-extracttemplates.1

.\"     Title: apt\-extracttemplates
.\"    Author: Jason Gunthorpe
.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
.\"      Date: 29 February 2004
.\"    Manual: 
.\"    Source: Linux
.\"
.TH "APT\-EXTRACTTEMPLATES" "1" "29 February 2004" "Linux" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
apt\-extracttemplates \- Utility to extract DebConf config and templates from Debian packages
.SH "SYNOPSIS"
.HP 21
\fBapt\-extracttemplates\fR [\fB\-hv\fR] [\fB\-t=\fR\fB\fItemporary\ directory\fR\fR] \fIfile\fR...
.SH "DESCRIPTION"
.PP
\fBapt\-extracttemplates\fR
will take one or more Debian package files as input and write out (to a temporary directory) all associated config scripts and template files. For each passed in package that contains config scripts and templates, one line of output will be generated in the format:
.PP
package version template\-file config\-script
.PP
template\-file and config\-script are written to the temporary directory specified by the \-t or \-\-tempdir (APT::ExtractTemplates::TempDir) directory, with filenames of the form
\fIpackage.template.XXXX\fR
and
\fIpackage.config.XXXX\fR
.SH "OPTIONS"
.PP
All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like
\fB\-f\-\fR,\fB\-\-no\-f\fR,
\fB\-f=no\fR
or several other variations.
.PP
\fB\-t\fR, \fB\-\-tempdir\fR
.RS 3n
Temporary directory in which to write extracted debconf template files and config scripts Configuration Item:
APT::ExtractTemplates::TempDir
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 3n
Show a short usage summary.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 3n
Show the program version.
.RE
.PP
\fB\-c\fR, \fB\-\-config\-file\fR
.RS 3n
Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. See
\fBapt.conf\fR(5)
for syntax information.
.RE
.PP
\fB\-o\fR, \fB\-\-option\fR
.RS 3n
Set a Configuration Option; This will set an arbitary configuration option. The syntax is
\fB\-o Foo::Bar=bar\fR.
.RE
.SH "SEE ALSO"
.PP
\fBapt.conf\fR(5)
.SH "DIAGNOSTICS"
.PP
\fBapt\-extracttemplates\fR
returns zero on normal operation, decimal 100 on error.
.SH "BUGS"
.PP
[1]\&\fIAPT bug page\fR. If you wish to report a bug in APT, please see
\fI/usr/share/doc/debian/bug\-reporting.txt\fR
or the
\fBreportbug\fR(1)
command.
.SH "AUTHORS"
.PP
\fBJason Gunthorpe\fR
.sp -1n
.IP "" 3n
Author.
.PP
\fBAPT team\fR
.sp -1n
.IP "" 3n
Author.
.SH "REFERENCES"
.TP 3
1.\ APT bug page
\%http://bugs.debian.org/src:apt
Commit	Line	Data
da6ee469 JF	1	.\" Title: apt\-extracttemplates
	2	.\" Author: Jason Gunthorpe
	3	.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
	4	.\" Date: 29 February 2004
	5	.\" Manual:
	6	.\" Source: Linux
	7	.\"
	8	.TH "APT\-EXTRACTTEMPLATES" "1" "29 February 2004" "Linux" ""
	9	.\" disable hyphenation
	10	.nh
	11	.\" disable justification (adjust text to left margin only)
	12	.ad l
	13	.SH "NAME"
	14	apt\-extracttemplates \- Utility to extract DebConf config and templates from Debian packages
	15	.SH "SYNOPSIS"
	16	.HP 21
	17	\fBapt\-extracttemplates\fR [\fB\-hv\fR] [\fB\-t=\fR\fB\fItemporary\ directory\fR\fR] \fIfile\fR...
	18	.SH "DESCRIPTION"
	19	.PP
	20	\fBapt\-extracttemplates\fR
	21	will take one or more Debian package files as input and write out (to a temporary directory) all associated config scripts and template files. For each passed in package that contains config scripts and templates, one line of output will be generated in the format:
	22	.PP
	23	package version template\-file config\-script
	24	.PP
	25	template\-file and config\-script are written to the temporary directory specified by the \-t or \-\-tempdir (APT::ExtractTemplates::TempDir) directory, with filenames of the form
	26	\fIpackage.template.XXXX\fR
	27	and
	28	\fIpackage.config.XXXX\fR
	29	.SH "OPTIONS"
	30	.PP
	31	All command line options may be set using the configuration file, the descriptions indicate the configuration option to set. For boolean options you can override the config file by using something like
	32	\fB\-f\-\fR,\fB\-\-no\-f\fR,
	33	\fB\-f=no\fR
	34	or several other variations.
	35	.PP
	36	\fB\-t\fR, \fB\-\-tempdir\fR
	37	.RS 3n
	38	Temporary directory in which to write extracted debconf template files and config scripts Configuration Item:
	39	APT::ExtractTemplates::TempDir
	40	.RE
	41	.PP
	42	\fB\-h\fR, \fB\-\-help\fR
	43	.RS 3n
	44	Show a short usage summary.
	45	.RE
	46	.PP
	47	\fB\-v\fR, \fB\-\-version\fR
	48	.RS 3n
	49	Show the program version.
	50	.RE
	51	.PP
	52	\fB\-c\fR, \fB\-\-config\-file\fR
	53	.RS 3n
	54	Configuration File; Specify a configuration file to use. The program will read the default configuration file and then this configuration file. See
	55	\fBapt.conf\fR(5)
	56	for syntax information.
	57	.RE
	58	.PP
	59	\fB\-o\fR, \fB\-\-option\fR
	60	.RS 3n
	61	Set a Configuration Option; This will set an arbitary configuration option. The syntax is
	62	\fB\-o Foo::Bar=bar\fR.
	63	.RE
	64	.SH "SEE ALSO"
65	.PP
66	\fBapt.conf\fR(5)
67	.SH "DIAGNOSTICS"
68	.PP
69	\fBapt\-extracttemplates\fR
70	returns zero on normal operation, decimal 100 on error.
71	.SH "BUGS"
72	.PP
73	[1]\&\fIAPT bug page\fR. If you wish to report a bug in APT, please see
74	\fI/usr/share/doc/debian/bug\-reporting.txt\fR
75	or the
76	\fBreportbug\fR(1)
77	command.
78	.SH "AUTHORS"
79	.PP
80	\fBJason Gunthorpe\fR
81	.sp -1n
82	.IP "" 3n
83	Author.
84	.PP
85	\fBAPT team\fR
86	.sp -1n
87	.IP "" 3n
88	Author.
89	.SH "REFERENCES"
90	.TP 3
91	1.\ APT bug page
92	\%http://bugs.debian.org/src:apt