From 5f5365e4b9dc74a7d70c8e21cfbcd45d4903e93e Mon Sep 17 00:00:00 2001 From: Tomas Mlcoch Date: Thu, 23 Feb 2017 15:49:22 +0100 Subject: [PATCH] Doc: Update man pages --- doc/createrepo_c.8 | 35 +++++++++++++++++++---------------- doc/mergerepo_c.8 | 2 +- doc/modifyrepo_c.8 | 2 +- doc/sqliterepo_c.8 | 2 +- 4 files changed, 22 insertions(+), 19 deletions(-) diff --git a/doc/createrepo_c.8 b/doc/createrepo_c.8 index e1312ff..3b4824e 100644 --- a/doc/createrepo_c.8 +++ b/doc/createrepo_c.8 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH CREATEREPO_C "2015-10-20" "" "" +.TH CREATEREPO_C "2017-02-23" "" "" .SH NAME createrepo_c \- Create rpm-md format (xml-rpm-metadata) repository . @@ -45,19 +45,19 @@ Run quietly. .SS \-v \-\-verbose .sp Run verbosely. -.SS \-x \-\-excludes +.SS \-x \-\-excludes PACKAGE_NAME_GLOB .sp File globs to exclude, can be specified multiple times. -.SS \-\-basedir +.SS \-\-basedir BASEDIR .sp Basedir for path to directories. -.SS \-u \-\-baseurl +.SS \-u \-\-baseurl URL .sp Optional base URL location for all files. .SS \-g \-\-groupfile GROUPFILE .sp Path to groupfile to include in metadata. -.SS \-s \-\-checksum +.SS \-s \-\-checksum CHECKSUM_TYPE .sp Choose the checksum type used in repomd.xml and for packages in the metadata. The default is now sha256. .SS \-p \-\-pretty @@ -78,22 +78,22 @@ Use the existing repodata for \-\-update from this path. .SS \-\-skip\-stat .sp Skip the stat() call on a \-\-update, assumes if the filename is the same then the file is still the same (only use this if you\(aqre fairly trusting or gullible). -.SS \-i \-\-pkglist +.SS \-\-split +.sp +Run in split media mode. Rather than pass a single directory, take a set of directories corresponding to different volumes in a media set. Meta data is created in the first given directory +.SS \-i \-\-pkglist FILENAME .sp Specify a text file which contains the complete list of files to include in the repository from the set found in the directory. File format is one package per line, no wildcards or globs. -.SS \-n \-\-includepkg +.SS \-n \-\-includepkg PACKAGE .sp Specify pkgs to include on the command line. Takes urls as well as local paths. -.SS \-o \-\-outputdir +.SS \-o \-\-outputdir URL .sp Optional output directory. .SS \-S \-\-skip\-symlinks .sp Ignore symlinks of packages. -.SS \-\-split -.sp -Run in split media mode. Rather than pass a single directory, take a set of directories corresponding to different volumes in a media set. Meta data is created in the first given directory -.SS \-\-changelog\-limit +.SS \-\-changelog\-limit NUM .sp Only import the last N changelog entries, from each rpm, into the metadata. .SS \-\-unique\-md\-filenames @@ -102,7 +102,7 @@ Include the file\(aqs checksum in the metadata filename, helps HTTP caching (def .SS \-\-simple\-md\-filenames .sp Do not include the file\(aqs checksum in the metadata filename. -.SS \-\-retain\-old\-md +.SS \-\-retain\-old\-md NUM .sp Keep around the latest (by timestamp) N copies of the old repodata. .SS \-\-distro DISTRO @@ -126,10 +126,10 @@ Number of workers to spawn to read rpms. .SS \-\-xz .sp Use xz for repodata compression. -.SS \-\-compress\-type +.SS \-\-compress\-type COMPRESSION_TYPE .sp Which compression type to use. -.SS \-\-general\-compress\-type +.SS \-\-general\-compress\-type COMPRESSION_TYPE .sp Which compression type to use (even for primary, filelists and other xml). .SS \-\-keep\-all\-metadata @@ -165,9 +165,12 @@ Ignore NUM of directory components in location_href during repodata generation .SS \-\-location\-prefix PREFIX .sp Append this prefix before location_href in output repodata -.SS \-\-repomd\-checksum +.SS \-\-repomd\-checksum CHECKSUM_TYPE .sp Checksum type to be used in repomd.xml +.SS \-\-error\-exit\-val +.sp +Exit with retval 2 if there were any errors during processing .SS \-\-ignore\-lock .sp Expert (risky) option: Ignore an existing .repodata/. (Remove the existing .repodata/ and create an empty new one to serve as a lock for other createrepo intances. For the repodata generation, a different temporary dir with the name in format .repodata.time.microseconds.pid/ will be used). NOTE: Use this option on your own risk! If two createrepos run simultaneously, then the state of the generated metadata is not guaranted \- it can be inconsistent and wrong. diff --git a/doc/mergerepo_c.8 b/doc/mergerepo_c.8 index 36701db..eae7d8b 100644 --- a/doc/mergerepo_c.8 +++ b/doc/mergerepo_c.8 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH MERGEREPO_C "2015-10-20" "" "" +.TH MERGEREPO_C "2017-02-23" "" "" .SH NAME mergerepo_c \- Merge multiple rpm-md format repositories together . diff --git a/doc/modifyrepo_c.8 b/doc/modifyrepo_c.8 index 46eac07..dee8ce3 100644 --- a/doc/modifyrepo_c.8 +++ b/doc/modifyrepo_c.8 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH MODIFYREPO_C "2015-10-20" "" "" +.TH MODIFYREPO_C "2017-02-23" "" "" .SH NAME modifyrepo_c \- Modify a repomd.xml of rpm-md format repository . diff --git a/doc/sqliterepo_c.8 b/doc/sqliterepo_c.8 index 28e241a..47400c0 100644 --- a/doc/sqliterepo_c.8 +++ b/doc/sqliterepo_c.8 @@ -1,6 +1,6 @@ .\" Man page generated from reStructuredText. . -.TH SQLITEREPO_C "2015-10-20" "" "" +.TH SQLITEREPO_C "2017-02-23" "" "" .SH NAME sqliterepo_c \- Generate sqlite db files for a repository in rpm-md format . -- 2.34.1