[Rpm-metadata] docs/createrepo.8 docs/mergerepo.1 docs/modifyrepo.1

James Antill james at osuosl.org
Fri Aug 9 19:05:33 UTC 2013 

 docs/createrepo.8 |   88 +++++++++++++++++++++++++++---------------------------
 docs/mergerepo.1  |   16 ++++-----
 docs/modifyrepo.1 |    2 -
 3 files changed, 53 insertions(+), 53 deletions(-)

New commits:
commit 417a0cb75d7e1992ce64b644aee187c4d72a8c13
Author: Mike Miller <mtmiller at ieee.org>
Date:   Tue Jul 9 09:41:30 2013 -0400

    docs: Escape dashes in command-line options
    
    By default groff interprets dashes as hyphens. Escape them in all
    command-line options to allow them to be copied and searched for.

diff --git a/docs/createrepo.8 b/docs/createrepo.8
index eefd4bf..6f6be10 100644
--- a/docs/createrepo.8
+++ b/docs/createrepo.8
@@ -11,118 +11,118 @@ createrepo \- Create repomd (xml-rpm-metadata) repository
 \fBcreaterepo\fP is a program that creates a repomd (xml-based rpm metadata) repository from a set of rpms.
 
 .SH "OPTIONS"
-.IP "\fB\-u --baseurl\fP <url>"
+.IP "\fB\-u \-\-baseurl\fP <url>"
 Optional base URL location for all files.
-.IP "\fB\-o --outputdir\fP <url>"
+.IP "\fB\-o \-\-outputdir\fP <url>"
 Optional output directory (useful for read only media).
-.IP "\fB\-x --excludes\fP <package>"
+.IP "\fB\-x \-\-excludes\fP <package>"
 File globs to exclude, can be specified multiple times.
-.IP "\fB\-i --pkglist\fP <filename>"
+.IP "\fB\-i \-\-pkglist\fP <filename>"
 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.
-.IP "\fB\-n --includepkg\fP"
+.IP "\fB\-n \-\-includepkg\fP"
 specify pkgs to include on the command line. Takes urls as well as local paths.
-.IP "\fB\-q --quiet\fP"
+.IP "\fB\-q \-\-quiet\fP"
 Run quietly.
-.IP "\fB\-g --groupfile\fP <groupfile>"
+.IP "\fB\-g \-\-groupfile\fP <groupfile>"
 A precreated xml filename to point to for group information.
 .br
 See examples section below for further explanation.
-.IP "\fB\-v --verbose\fP"
+.IP "\fB\-v \-\-verbose\fP"
 Run verbosely.
-.IP "\fB\-c --cachedir\fP <path>"
+.IP "\fB\-c \-\-cachedir\fP <path>"
 Specify a directory to use as a cachedir. This allows createrepo to create a
 cache of checksums of packages in the repository. In consecutive runs of
 createrepo over the same repository of files that do not have a complete
 change out of all packages this decreases the processing time dramatically.
 .br
-.IP "\fB\--basedir\fP"
+.IP "\fB\-\-basedir\fP"
 Basedir for path to directories in the repodata, default is the current working
 directory.
 .br
-.IP "\fB\--update\fP"
+.IP "\fB\-\-update\fP"
 If metadata already exists in the outputdir and an rpm is unchanged
 (based on file size and mtime) since the metadata was generated, reuse
 the existing metadata rather than recalculating it. In the case of a
 large repository with only a few new or modified rpms this can
 significantly reduce I/O and processing time.
 .br
-.IP "\fB\--skip-stat\fP"
-skip the stat() call on a --update, assumes if the filename is the same
+.IP "\fB\-\-skip\-stat\fP"
+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're fairly trusting or
 gullible).
 .br
-.IP "\fB\--update-md-path\fP"
-Use the existing repodata for --update, from this path.
+.IP "\fB\-\-update\-md\-path\fP"
+Use the existing repodata for \-\-update, from this path.
 .br
-.IP "\fB\-C --checkts\fP"
+.IP "\fB\-C \-\-checkts\fP"
 Don't generate repo metadata, if their timestamps are newer than its rpms.
 This option decreases the processing time drastically again, if you happen
 to run it on an unmodified repo, but it is (currently) mutual exclusive
-with the --split option. NOTE: This command will not notice when 
-packages have been removed from repo. Use --update to handle that.
+with the \-\-split option. NOTE: This command will not notice when
+packages have been removed from repo. Use \-\-update to handle that.
 .br
-.IP "\fB\--split\fP"
+.IP "\fB\-\-split\fP"
 Run in split media mode. Rather than pass a single directory, take a set of
 directories corresponding to different volumes in a media set.
 .br
-.IP "\fB\-p --pretty\fP"
+.IP "\fB\-p \-\-pretty\fP"
 Output xml files in pretty format.
-.IP "\fB\--version\fP"
+.IP "\fB\-\-version\fP"
 Output version.
-.IP "\fB\-h --help\fP"
+.IP "\fB\-h \-\-help\fP"
 Show help menu.
 
-.IP "\fB\-d --database\fP"
+.IP "\fB\-d \-\-database\fP"
 Generate sqlite databases for use with yum. This is now the default.
 
-.IP "\fB\--no-database\fP"
+.IP "\fB\-\-no\-database\fP"
 Do not generate sqlite databases in the repository.
 
-.IP "\fB\-S --skip-symlinks\fP"
+.IP "\fB\-S \-\-skip\-symlinks\fP"
 Ignore symlinks of packages
-.IP "\fB\-s --checksum\fP"
+.IP "\fB\-s \-\-checksum\fP"
 Choose the checksum type used in repomd.xml and for packages in the metadata.
 The default is now "sha256" (if python has hashlib). The older default was
 "sha", which is actually "sha1", however explicitly using "sha1" doesn't work
 on older (3.0.x) versions of yum, you need to specify "sha".
-.IP "\fB\--profile\fP"
+.IP "\fB\-\-profile\fP"
 Output time based profiling information.
-.IP "\fB\--changelog-limit\fP CHANGELOG_LIMIT"
+.IP "\fB\-\-changelog\-limit\fP CHANGELOG_LIMIT"
 Only import the last N changelog entries, from each rpm, into the metadata
-.IP "\fB\--unique-md-filenames\fP"
+.IP "\fB\-\-unique\-md\-filenames\fP"
 Include the file's checksum in the metadata filename, helps HTTP caching (default)
 
-.IP "\fB\--simple-md-filenames\fP"
+.IP "\fB\-\-simple\-md\-filenames\fP"
 Do not include the file's checksum in the metadata filename.
 
-.IP "\fB\--retain-old-md\fP"
+.IP "\fB\-\-retain\-old\-md\fP"
 Keep around the latest (by timestamp) N copies of the old repodata (so clients
 with older repomd.xml files can still access it). Default is 0.
 
-.IP "\fB\--distro\fP"
+.IP "\fB\-\-distro\fP"
 Specify distro tags. Can be specified more than once. Optional syntax specifying a
-cpeid(http://cpe.mitre.org/) --distro=cpeid,distrotag
-.IP "\fB\--content\fP"
+cpeid(http://cpe.mitre.org/) \-\-distro=cpeid,distrotag
+.IP "\fB\-\-content\fP"
 Specify keyword/tags about the content of the repository. Can be specified more than once.
-.IP "\fB\--repo\fP"
+.IP "\fB\-\-repo\fP"
 Specify keyword/tags about the repository itself. Can be specified more than once.
-.IP "\fB\--revision\fP"
+.IP "\fB\-\-revision\fP"
 Arbitrary string for a repository revision.
-.IP "\fB\--deltas\fP"
+.IP "\fB\-\-deltas\fP"
 Tells createrepo to generate deltarpms and the delta metadata
-.IP "\fB\--oldpackagedirs\fP PATH"
+.IP "\fB\-\-oldpackagedirs\fP PATH"
 paths to look for older pkgs to delta against. Can be specified multiple times
-.IP "\fB\--num-deltas\fP int"
+.IP "\fB\-\-num\-deltas\fP int"
 the number of older versions to make deltas against. Defaults to 1
-.IP "\fB\--read-pkgs-list\fP READ_PKGS_LIST
-output the paths to the pkgs actually read useful with  --update
-.IP "\fB\--max-delta-rpm-size\fP MAX_DELTA_RPM_SIZE
+.IP "\fB\-\-read\-pkgs\-list\fP READ_PKGS_LIST
+output the paths to the pkgs actually read useful with \-\-update
+.IP "\fB\-\-max\-delta\-rpm\-size\fP MAX_DELTA_RPM_SIZE
 max size of an rpm that to run deltarpm against (in bytes)
-.IP "\fB\--workers\fP WORKERS
+.IP "\fB\-\-workers\fP WORKERS
 number of workers to spawn to read rpms
-.IP "\fB\--compress-type\fP
+.IP "\fB\-\-compress\-type\fP
 specify which compression method to use: compat (default),
 xz (may not be available), gz, bz2.
 .IP
diff --git a/docs/mergerepo.1 b/docs/mergerepo.1
index 2529e7a..4c10b1e 100644
--- a/docs/mergerepo.1
+++ b/docs/mergerepo.1
@@ -4,7 +4,7 @@
 mergerepo \- Merge multiple repositories together
 
 .SH "SYNOPSIS"
-\fBmergerepo\fP --repo repo1 --repo repo2
+\fBmergerepo\fP \-\-repo repo1 \-\-repo repo2
 .PP
 
 .SH "DESCRIPTION"
@@ -13,29 +13,29 @@ into a single repository while referring to the remote location for all
 packages.
 
 .SH "OPTIONS"
-.IP "\fB\-r --repo\fP <url>"
+.IP "\fB\-r \-\-repo\fP <url>"
 Url to a repository to be merged.
 
-.IP "\fB\-o --outputdir <directory>\fP"
+.IP "\fB\-o \-\-outputdir <directory>\fP"
 Path where merged repository metadata should be written to. If not specified
 repository metadata will be written to `pwd`/merged_repo/.
 
-.IP "\fB\-d --database\fP"
+.IP "\fB\-d \-\-database\fP"
 Generate sqlite databases of the merged repository metadata.
 
-.IP "\fB\-a --archlist\fP"
+.IP "\fB\-a \-\-archlist\fP"
 Specify a comma-separated list of architectures to use. Defaults to ALL.
 
-.IP "\fB\--nogroups\fP"
+.IP "\fB\-\-nogroups\fP"
 Do not merge/include groups metadata in the repository.
 
-.IP "\fB\--noupdateinfo\fP"
+.IP "\fB\-\-noupdateinfo\fP"
 Do not merge/include updateinfo metadata in the repository.
 
 
 .SH "EXAMPLES"
 .PP
-$ \fBmergerepo\fP --repo=http://myurl.org/repo1 --repo=http://myurl.org/repo2 -d -o /tmp/mymergedrepo 
+$ \fBmergerepo\fP \-\-repo=http://myurl.org/repo1 \-\-repo=http://myurl.org/repo2 \-d \-o /tmp/mymergedrepo
 
 .PP 
 .SH "SEE ALSO"
diff --git a/docs/modifyrepo.1 b/docs/modifyrepo.1
index cc031f5..1eeda56 100644
--- a/docs/modifyrepo.1
+++ b/docs/modifyrepo.1
@@ -12,7 +12,7 @@ modifyrepo \- Modify a repomd (xml-rpm-metadata) repository
 
 .SH "EXAMPLES"
 .PP
-$ \fBmodifyrepo\fP --mdtype=newmd metadata.xml /repository/repodata
+$ \fBmodifyrepo\fP \-\-mdtype=newmd metadata.xml /repository/repodata
 .br
 Wrote: /repository/repodata/metadata.xml.gz
            type = newmd

More information about the Rpm-metadata mailing list