From: Michael Schroeder Date: Mon, 22 Sep 2014 16:25:43 +0000 (+0200) Subject: Start adding man-pages for the tools X-Git-Tag: 0.6.6~7 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3de5f0b39a6f8915ecd64e45a3bb1fa2497e0aea;p=thirdparty%2Flibsolv.git Start adding man-pages for the tools --- diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt index fc588e77..837b87b1 100644 --- a/doc/CMakeLists.txt +++ b/doc/CMakeLists.txt @@ -1,8 +1,15 @@ -SET (libsolv_MANPAGES +SET (libsolv_MANPAGES3 libsolv.3 libsolv-bindings.3 libsolv-constantids.3 libsolv-history.3 libsolv-pool.3) +SET (libsolv_MANPAGES1 + mergesolv.1 dumpsolv.1 installcheck.1 testsolv.1) + INSTALL(FILES - ${libsolv_MANPAGES} + ${libsolv_MANPAGES3} DESTINATION "${MAN_INSTALL_DIR}/man3") + +INSTALL(FILES + ${libsolv_MANPAGES1} + DESTINATION "${MAN_INSTALL_DIR}/man1") diff --git a/doc/Makefile.gen b/doc/Makefile.gen index e18d0bc0..dba7822a 100644 --- a/doc/Makefile.gen +++ b/doc/Makefile.gen @@ -1,9 +1,13 @@ -man: libsolv.3 libsolv-bindings.3 libsolv-constantids.3 libsolv-history.3 libsolv-pool.3 +man: libsolv.3 libsolv-bindings.3 libsolv-constantids.3 libsolv-history.3 libsolv-pool.3 \ + mergesolv.1 dumpsolv.1 installcheck.1 testsolv.1 html: libsolv.html libsolv-bindings.html libsolv-constantids.html libsolv-history.html libsolv-pool.html -.SUFFIXES: .html .3 .txt +.SUFFIXES: .html .3 .1 .txt + +.txt.1: + a2x -f manpage $< .txt.3: a2x -f manpage $< diff --git a/doc/dumpsolv.1 b/doc/dumpsolv.1 new file mode 100644 index 00000000..3e1400e6 --- /dev/null +++ b/doc/dumpsolv.1 @@ -0,0 +1,45 @@ +'\" t +.\" Title: dumpsolv +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 09/22/2014 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "DUMPSOLV" "1" "09/22/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" +dumpsolv \- print a solv file into a human readable format +.SH "SYNOPSIS" +.sp +\fBdumpsolv\fR [\fIOPTIONS\fR] [\fIFILE\&.solv\fR] +.SH "DESCRIPTION" +.sp +The dumpsolv tool reads a solv files and writes its contents to standard output\&. If no input file is given, it reads the solv file from standard input\&. +.PP +\fB\-j\fR +.RS 4 +Write the contents in JSON format\&. +.RE +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/doc/dumpsolv.txt b/doc/dumpsolv.txt new file mode 100644 index 00000000..ec2d7716 --- /dev/null +++ b/doc/dumpsolv.txt @@ -0,0 +1,26 @@ +dumpsolv(1) +=========== +:man manual: LIBSOLV +:man source: libsolv + + +Name +---- +dumpsolv - print a solv file into a human readable format + +Synopsis +-------- +*dumpsolv* ['OPTIONS'] ['FILE.solv'] + +Description +----------- +The dumpsolv tool reads a solv files and writes its contents +to standard output. If no input file is given, it reads the +solv file from standard input. + +*-j*:: +Write the contents in JSON format. + +Author +------ +Michael Schroeder diff --git a/doc/installcheck.1 b/doc/installcheck.1 new file mode 100644 index 00000000..85e4d89f --- /dev/null +++ b/doc/installcheck.1 @@ -0,0 +1,42 @@ +'\" t +.\" Title: installcheck +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 09/22/2014 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "INSTALLCHECK" "1" "09/22/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" +installcheck \- find out which packages cannot be installed +.SH "SYNOPSIS" +.sp +\fBinstallcheck\fR \fIARCH\fR \fIREPO1\fR \fIREPO2\fR\&... \fB\-\-nocheck\fR \fINREPO1\fR \fINREPO2\fR\&... +.SH "DESCRIPTION" +.sp +The installcheck tool checks if all packages in \fIREPO1\fR\&...\fIREPON\fR are installable\&. A package is installable if there is a set of packages from the repositories that satisfies its dependencies\&. The repositories after the \fB\-\-nocheck\fR option are only used for dependency resolving, but the tool does not check if the packages in them are installable\&. +.sp +A Repository can be a solv file, a rpmmd \fBprimary\&.xml\&.gz\fR file, a SUSE \fBpackages\fR or \fBpackages\&.gz\fR file, or a Debian \fBPackages\fR or \fBPackages\&.gz\fR file\&. +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/doc/installcheck.txt b/doc/installcheck.txt new file mode 100644 index 00000000..99eb2797 --- /dev/null +++ b/doc/installcheck.txt @@ -0,0 +1,29 @@ +installcheck(1) +=============== +:man manual: LIBSOLV +:man source: libsolv + + +Name +---- +installcheck - find out which packages cannot be installed + +Synopsis +-------- +*installcheck* 'ARCH' 'REPO1' 'REPO2'... *--nocheck* 'NREPO1' 'NREPO2'... + +Description +----------- +The installcheck tool checks if all packages in 'REPO1'...'REPON' are +installable. A package is installable if there is a set of packages +from the repositories that satisfies its dependencies. The repositories +after the *--nocheck* option are only used for dependency resolving, +but the tool does not check if the packages in them are installable. + +A Repository can be a solv file, a rpmmd *primary.xml.gz* file, a SUSE +*packages* or *packages.gz* file, or a Debian *Packages* or *Packages.gz* +file. + +Author +------ +Michael Schroeder diff --git a/doc/mergesolv.1 b/doc/mergesolv.1 new file mode 100644 index 00000000..e7cdd263 --- /dev/null +++ b/doc/mergesolv.1 @@ -0,0 +1,45 @@ +'\" t +.\" Title: mergesolv +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 09/22/2014 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "MERGESOLV" "1" "09/22/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" +mergesolv \- merge multiple files in solv format into a single one +.SH "SYNOPSIS" +.sp +\fBmergesolv\fR [\fIOPTIONS\fR] \fIFILE1\&.solv\fR \fIFILE2\&.solv\fR \&... +.SH "DESCRIPTION" +.sp +The mergesolv tool reads all solv files specified on the command line, and writes a merged version to standard output\&. +.PP +\fB\-X\fR +.RS 4 +Autoexpand SUSE pattern and product provides into packages\&. +.RE +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/doc/mergesolv.txt b/doc/mergesolv.txt new file mode 100644 index 00000000..bbe8c725 --- /dev/null +++ b/doc/mergesolv.txt @@ -0,0 +1,25 @@ +mergesolv(1) +============ +:man manual: LIBSOLV +:man source: libsolv + + +Name +---- +mergesolv - merge multiple files in solv format into a single one + +Synopsis +-------- +*mergesolv* ['OPTIONS'] 'FILE1.solv' 'FILE2.solv' ... + +Description +----------- +The mergesolv tool reads all solv files specified on the command line, +and writes a merged version to standard output. + +*-X*:: +Autoexpand SUSE pattern and product provides into packages. + +Author +------ +Michael Schroeder diff --git a/doc/testsolv.1 b/doc/testsolv.1 new file mode 100644 index 00000000..faf97b61 --- /dev/null +++ b/doc/testsolv.1 @@ -0,0 +1,62 @@ +'\" t +.\" Title: testsolv +.\" Author: [see the "Author" section] +.\" Generator: DocBook XSL Stylesheets v1.78.0 +.\" Date: 09/22/2014 +.\" Manual: LIBSOLV +.\" Source: libsolv +.\" Language: English +.\" +.TH "TESTSOLV" "1" "09/22/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" +testsolv \- run a libsolv testcase through the solver +.SH "SYNOPSIS" +.sp +\fBtestsolv\fR [\fIOPTIONS\fR] \fITESTCASE\fR +.SH "DESCRIPTION" +.sp +The testsolv tools can be used to run a testcase\&. Testcases can either be manually created to test specific features, or they can be written by libsolv\(cqs testcase_write function\&. This is useful to evaluate bug reports about the solver\&. +.PP +\fB\-v\fR +.RS 4 +Increase the debug level of the solver\&. This option can be specified multiple times to further increase the amount of debug data\&. +.RE +.PP +\fB\-r\fR +.RS 4 +Write the output in testcase format instead of human readable text\&. The output can then be used in the result section of the test case\&. If the +\fB\-r\fR +option is given twice, the output is formated for verbatim inclusion\&. +.RE +.PP +\fB\-l\fR \fIPKGSPEC\fR +.RS 4 +Instead of running the solver, list packages in the repositories\&. +.RE +.PP +\fB\-s\fR \fISOLUTIONSPEC\fR +.RS 4 +This is used in the solver test suite to test the calculated solutions to encountered problems\&. +.RE +.SH "AUTHOR" +.sp +Michael Schroeder diff --git a/doc/testsolv.txt b/doc/testsolv.txt new file mode 100644 index 00000000..dc3a34ee --- /dev/null +++ b/doc/testsolv.txt @@ -0,0 +1,41 @@ +testsolv(1) +=========== +:man manual: LIBSOLV +:man source: libsolv + + +Name +---- +testsolv - run a libsolv testcase through the solver + +Synopsis +-------- +*testsolv* ['OPTIONS'] 'TESTCASE' + +Description +----------- +The testsolv tools can be used to run a testcase. Testcases can +either be manually created to test specific features, or they +can be written by libsolv's testcase_write function. This is useful +to evaluate bug reports about the solver. + +*-v*:: +Increase the debug level of the solver. This option can be specified +multiple times to further increase the amount of debug data. + +*-r*:: +Write the output in testcase format instead of human readable text. +The output can then be used in the result section of the test case. +If the *-r* option is given twice, the output is formated for +verbatim inclusion. + +*-l* 'PKGSPEC':: +Instead of running the solver, list packages in the repositories. + +*-s* 'SOLUTIONSPEC':: +This is used in the solver test suite to test the calculated solutions +to encountered problems. + +Author +------ +Michael Schroeder diff --git a/package/libsolv.spec.in b/package/libsolv.spec.in index b6610c46..2d48277b 100644 --- a/package/libsolv.spec.in +++ b/package/libsolv.spec.in @@ -221,6 +221,7 @@ rm -rf "$RPM_BUILD_ROOT" %endif %exclude %{_bindir}/solv %{_bindir}/* +%{_mandir}/man1/* %files devel %defattr(-,root,root) @@ -237,7 +238,7 @@ rm -rf "$RPM_BUILD_ROOT" %{_bindir}/helix2solv %endif %{_datadir}/cmake/Modules/* -%{_mandir}/man?/* +%{_mandir}/man3/* %files demo %defattr(-,root,root)