From: Michael Schroeder Date: Wed, 24 Sep 2014 16:29:22 +0000 (+0200) Subject: add more man pages X-Git-Tag: 0.6.6~5 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=964c48bc19fae84d4d135ca3361055e5a78aa7a6;p=thirdparty%2Flibsolv.git add more man pages --- diff --git a/doc/Makefile.gen b/doc/Makefile.gen index dba7822a..3157ab37 100644 --- a/doc/Makefile.gen +++ b/doc/Makefile.gen @@ -1,6 +1,10 @@ -man: libsolv.3 libsolv-bindings.3 libsolv-constantids.3 libsolv-history.3 libsolv-pool.3 \ - mergesolv.1 dumpsolv.1 installcheck.1 testsolv.1 +man: man3 man1 + +man3: libsolv.3 libsolv-bindings.3 libsolv-constantids.3 libsolv-history.3 libsolv-pool.3 + +man1: mergesolv.1 dumpsolv.1 installcheck.1 testsolv.1 rpmdb2solv.1 rpms2solv.1 \ + rpmmd2solv.1 repomdxml2solv.1 html: libsolv.html libsolv-bindings.html libsolv-constantids.html libsolv-history.html libsolv-pool.html diff --git a/doc/repomdxml2solv.1 b/doc/repomdxml2solv.1 new file mode 100644 index 00000000..d00fa02c --- /dev/null +++ b/doc/repomdxml2solv.1 @@ -0,0 +1,57 @@ +'\" t +.\" Title: repomdxml2solv +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 09/24/2014 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "REPOMDXML2SOLV" "1" "09/24/2014" "libsolv" "LIBSOLV" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +repomdxml2solv \- convert a repomd\&.xml file into a solv file +.SH "SYNOPSIS" +.sp +\fBrepomdxml2solv\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The repomd\&.xml file is the index file of a rpm\-md repository, containing references to all data file with checksums\&. The repomdxml2solv tool reads the repomd\&.xml file from stdin and writes the parsed data as solv file to standard output\&. The data is stored as meta attributes in the result\&. +.PP +\fB\-q\fR \fIWHAT\fR +.RS 4 +Data query mode: instead of writing a solv file, select the +\fIWHAT\fR +element in the input data and write it to standard output\&. Examples for +\fIWHAT\fR +are +\fBtype\fR +to get a list of all types, and +\fBprimary:location\fR +to get the location of the element with type +\fBprimary\fR\&. +.RE +.SH "SEE ALSO" +.sp +rpmmd2solv(1), mergesolv(1), createrepo(8) +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/doc/repomdxml2solv.txt b/doc/repomdxml2solv.txt new file mode 100644 index 00000000..feb859ce --- /dev/null +++ b/doc/repomdxml2solv.txt @@ -0,0 +1,36 @@ +repomdxml2solv(1) +================= +:man manual: LIBSOLV +:man source: libsolv + + +Name +---- +repomdxml2solv - convert a repomd.xml file into a solv file + +Synopsis +-------- +*repomdxml2solv* ['OPTIONS'] + +Description +----------- +The repomd.xml file is the index file of a rpm-md repository, +containing references to all data file with checksums. The +repomdxml2solv tool reads the repomd.xml file from stdin and +writes the parsed data as solv file to standard output. The +data is stored as meta attributes in the result. + +*-q* 'WHAT':: +Data query mode: instead of writing a solv file, select the +'WHAT' element in the input data and write it to standard output. +Examples for 'WHAT' are *type* to get a list of all types, and +*primary:location* to get the location of the element with +type *primary*. + +See Also +-------- +rpmmd2solv(1), mergesolv(1), createrepo(8) + +Author +------ +Michael Schroeder diff --git a/doc/rpmdb2solv.1 b/doc/rpmdb2solv.1 new file mode 100644 index 00000000..b740002e --- /dev/null +++ b/doc/rpmdb2solv.1 @@ -0,0 +1,95 @@ +'\" t +.\" Title: rpmdb2solv +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 09/24/2014 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "RPMDB2SOLV" "1" "09/24/2014" "libsolv" "LIBSOLV" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +rpmdb2solv \- convert the rpm database into a solv file +.SH "SYNOPSIS" +.sp +\fBrpmdb2solv\fR [\fIOPTIONS\fR] [\fIREFFILE\&.solv\fR] +.SH "DESCRIPTION" +.sp +The rpmdb2solv tool reads rpm\(cqs installed packages database and writes it in solv file format to standard output\&. You can make use of an old version of the database by specifying a \fIREFFILE\&.solv\fR file\&. +.PP +\fB\-o\fR \fIOUTFILE\fR +.RS 4 +Write the generated solv to +\fIOUTFILE\fR +instead of standard output\&. +.RE +.PP +\fB\-P\fR +.RS 4 +Print percentages as packages are being read in\&. The output format is like rpm\(cqs \-\-percent option\&. +.RE +.PP +\fB\-r\fR \fIROOT\fR +.RS 4 +Use +\fIROOT\fR +as root directory\&. +.RE +.PP +\fB\-k\fR +.RS 4 +Read pubkeys from the rpm database instead of installed packages\&. Note that many distributions stopped storing pubkeys in the database but use a directory like +\fB/var/lib/rpm/pubkeys\fR +instead\&. +.RE +.PP +\fB\-A\fR +.RS 4 +Also scan the +\fB/usr/share/appdata\fR +for installed appdata files and create pseudo packages for each file\&. +.RE +.PP +\fB\-p\fR \fIPRODDIR\fR +.RS 4 +Also read SUSE product files from directory +\fIPRODDIR\fR\&. The standard directory is +\fB/etc/products\&.d\fR\&. +.RE +.PP +\fB\-n\fR +.RS 4 +Do not read any packages from the rpm database\&. This is useful together with +\fB\-p\fR +to only convert SUSE products\&. +.RE +.PP +\fB\-X\fR +.RS 4 +Autoexpand SUSE pattern and product provides into packages\&. +.RE +.SH "SEE ALSO" +.sp +rpms2solv(1) +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/doc/rpmdb2solv.txt b/doc/rpmdb2solv.txt new file mode 100644 index 00000000..2778199a --- /dev/null +++ b/doc/rpmdb2solv.txt @@ -0,0 +1,59 @@ +rpmdb2solv(1) +============= +:man manual: LIBSOLV +:man source: libsolv + + +Name +---- +rpmdb2solv - convert the rpm database into a solv file + +Synopsis +-------- +*rpmdb2solv* ['OPTIONS'] ['REFFILE.solv'] + +Description +----------- +The rpmdb2solv tool reads rpm's installed packages database +and writes it in solv file format to standard output. You can +make use of an old version of the database by specifying a +'REFFILE.solv' file. + +*-o* 'OUTFILE':: +Write the generated solv to 'OUTFILE' instead of standard output. + +*-P*:: +Print percentages as packages are being read in. The output +format is like rpm's --percent option. + +*-r* 'ROOT':: +Use 'ROOT' as root directory. + +*-k*:: +Read pubkeys from the rpm database instead of installed packages. +Note that many distributions stopped storing pubkeys in the +database but use a directory like */var/lib/rpm/pubkeys* +instead. + +*-A*:: +Also scan the */usr/share/appdata* for installed appdata files +and create pseudo packages for each file. + +*-p* 'PRODDIR':: +Also read SUSE product files from directory 'PRODDIR'. The +standard directory is */etc/products.d*. + +*-n*:: +Do not read any packages from the rpm database. This is useful +together with *-p* to only convert SUSE products. + +*-X*:: +Autoexpand SUSE pattern and product provides into packages. + +See Also +-------- +rpms2solv(1) + +Author +------ +Michael Schroeder diff --git a/doc/rpmmd2solv.1 b/doc/rpmmd2solv.1 new file mode 100644 index 00000000..249d8017 --- /dev/null +++ b/doc/rpmmd2solv.1 @@ -0,0 +1,48 @@ +'\" t +.\" Title: rpmmd2solv +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 09/24/2014 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "RPMMD2SOLV" "1" "09/24/2014" "libsolv" "LIBSOLV" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +rpmmd2solv \- convert files in rpm\-md format into a solv file +.SH "SYNOPSIS" +.sp +\fBrpmmd2solv\fR [\fIOPTIONS\fR] +.SH "DESCRIPTION" +.sp +The rpmmd2solv tool reads rpm\-md xml data from stdin, and writes it as solv file to standard output\&. It understands the \fBprimary\fR, \fBfilelist\fR, \fBother\fR, and \fBsusedata\fR format\&. +.PP +\fB\-X\fR +.RS 4 +Autoexpand SUSE pattern and product provides into packages\&. +.RE +.SH "SEE ALSO" +.sp +repomdxml2solv(1), mergesolv(1), createrepo(8) +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/doc/rpmmd2solv.txt b/doc/rpmmd2solv.txt new file mode 100644 index 00000000..c72ccc91 --- /dev/null +++ b/doc/rpmmd2solv.txt @@ -0,0 +1,30 @@ +rpmmd2solv(1) +============= +:man manual: LIBSOLV +:man source: libsolv + + +Name +---- +rpmmd2solv - convert files in rpm-md format into a solv file + +Synopsis +-------- +*rpmmd2solv* ['OPTIONS'] + +Description +----------- +The rpmmd2solv tool reads rpm-md xml data from stdin, and writes +it as solv file to standard output. It understands the *primary*, +*filelist*, *other*, and *susedata* format. + +*-X*:: +Autoexpand SUSE pattern and product provides into packages. + +See Also +-------- +repomdxml2solv(1), mergesolv(1), createrepo(8) + +Author +------ +Michael Schroeder diff --git a/doc/rpms2solv.1 b/doc/rpms2solv.1 new file mode 100644 index 00000000..c6a2725c --- /dev/null +++ b/doc/rpms2solv.1 @@ -0,0 +1,80 @@ +'\" t +.\" Title: rpms2solv +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 09/24/2014 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "RPMS2SOLV" "1" "09/24/2014" "libsolv" "LIBSOLV" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +rpms2solv \- convert one or more rpms into a solv file +.SH "SYNOPSIS" +.sp +\fBrpms2solv\fR [\fIOPTIONS\fR] \fIRPM1\&.rpm\fR \&... +.SH "DESCRIPTION" +.sp +The rpms2solv tool converts the header data from one or more rpms into the solv file written to standard output\&. +.PP +\fB\-m\fR \fIMANIFESTFILE\fR +.RS 4 +Read the rpm file names from the specified +\fIMANIFESTFILE\fR\&. You can use +\fB\-\fR +to read the manifest from standard input\&. +.RE +.PP +\fB\-0\fR +.RS 4 +Use a null byte as line terminator for manifest files instead of a newline\&. This is useful if the file names can contain newlines\&. See also the +\fB\-print0\fR +option in +\fBfind\fR\&. +.RE +.PP +\fB\-F\fR +.RS 4 +Do not put all files from the headers into the file list, but instead use the filtering also found in +\fBcreaterepo\fR\&. +.RE +.PP +\fB\-k\fR +.RS 4 +Read pubkeys instead of rpms\&. +.RE +.PP +\fB\-K\fR +.RS 4 +Read pubkey keyrings instead of rpms\&. +.RE +.PP +\fB\-X\fR +.RS 4 +Autoexpand SUSE pattern and product provides into packages\&. +.RE +.SH "SEE ALSO" +.sp +rpmdb2solv(1) +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/doc/rpms2solv.txt b/doc/rpms2solv.txt new file mode 100644 index 00000000..244dffb1 --- /dev/null +++ b/doc/rpms2solv.txt @@ -0,0 +1,48 @@ +rpms2solv(1) +============ +:man manual: LIBSOLV +:man source: libsolv + + +Name +---- +rpms2solv - convert one or more rpms into a solv file + +Synopsis +-------- +*rpms2solv* ['OPTIONS'] 'RPM1.rpm' ... + +Description +----------- +The rpms2solv tool converts the header data from one or more +rpms into the solv file written to standard output. + +*-m* 'MANIFESTFILE':: +Read the rpm file names from the specified 'MANIFESTFILE'. You can +use *-* to read the manifest from standard input. + +*-0*:: +Use a null byte as line terminator for manifest files instead of +a newline. This is useful if the file names can contain newlines. +See also the *-print0* option in *find*. + +*-F*:: +Do not put all files from the headers into the file list, but +instead use the filtering also found in *createrepo*. + +*-k*:: +Read pubkeys instead of rpms. + +*-K*:: +Read pubkey keyrings instead of rpms. + +*-X*:: +Autoexpand SUSE pattern and product provides into packages. + +See Also +-------- +rpmdb2solv(1) + +Author +------ +Michael Schroeder