Bläddra i källkod

fixed man page sections

Christoph Schug 23 år sedan
förälder
incheckning
3bce51acd3
3 ändrade filer med 105 tillägg och 46 borttagningar
  1. 2 2
      openpkg-tool/openpkg-tool.spec
  2. 99 40
      openpkg-tool/openpkg.1
  3. 4 4
      openpkg-tool/openpkg.pod

+ 2 - 2
openpkg-tool/openpkg-tool.spec

@@ -32,8 +32,8 @@ Packager:     The OpenPKG Project
 Distribution: OpenPKG [EVAL]
 Group:        Bootstrapping
 License:      GPL
-Version:      20021220
-Release:      20021220
+Version:      20021226
+Release:      20021226
 
 #   list of sources
 Source0:      openpkg.sh

+ 99 - 40
openpkg-tool/openpkg.1

@@ -1,7 +1,8 @@
-.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
+.\" Automatically generated by Pod::Man version 1.15
+.\" Thu Dec 26 13:41:09 2002
 .\"
 .\" Standard preamble:
-.\" ========================================================================
+.\" ======================================================================
 .de Sh \" Subsection heading
 .br
 .if t .Sp
@@ -14,6 +15,12 @@
 .if t .sp .5v
 .if n .sp
 ..
+.de Ip \" List item
+.br
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
 .de Vb \" Begin verbatim text
 .ft CW
 .nf
@@ -21,14 +28,15 @@
 ..
 .de Ve \" End verbatim text
 .ft R
+
 .fi
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 .\" double quote, and \*(R" will give a right double quote.  | will give a
-.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
-.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
-.\" expand to `' in nroff, nothing in troff, for use with C<>.
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
+.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
+.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
 .tr \(*W-|\(bv\*(Tr
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
@@ -48,10 +56,10 @@
 .    ds R" ''
 'br\}
 .\"
-.\" If the F register is turned on, we'll generate index entries on stderr for
-.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
-.\" entries marked with X<> in POD.  Of course, you'll have to process the
-.\" output yourself in some meaningful fashion.
+.\" If the F register is turned on, we'll generate index entries on stderr
+.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
+.\" index entries marked with X<> in POD.  Of course, you'll have to process
+.\" the output yourself in some meaningful fashion.
 .if \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
@@ -60,13 +68,14 @@
 .    rr F
 .\}
 .\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
-.\" way too many mistakes in technical documents.
+.\" For nroff, turn off justification.  Always turn off hyphenation; it
+.\" makes way too many mistakes in technical documents.
 .hy 0
 .if n .na
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.bd B 3
 .    \" fudge factors for nroff and troff
 .if n \{\
 .    ds #H 0
@@ -126,15 +135,16 @@
 .    ds Ae AE
 .\}
 .rm #[ #] #H #V #F C
-.\" ========================================================================
+.\" ======================================================================
 .\"
 .IX Title "OPENPKG 1"
-.TH OPENPKG 1 "2002-11-27" "openpkg-tool" "OpenPKG Maintainance"
+.TH OPENPKG 1 "openpkg-tool" "2002-12-26" "OpenPKG Maintainance"
+.UC
 .SH "NAME"
 \&\fBopenpkg\fR \- \fBOpenPKG\fR maintainance utility
 .SH "VERSION"
 .IX Header "VERSION"
-openpkg-tool XX-VERSION-XX
+openpkg-tool \s-1XX-VERSION-XX\s0
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 \&\fBopenpkg\fR 
@@ -158,6 +168,8 @@ openpkg-tool XX-VERSION-XX
 [\fB\-Z\fR]
 [\fB\-i\fR]
 [\fB\-q\fR]
+[\fB\-s\fR]
+[\fB\-S\fR]
 [\fB\-P\fR \fIpriv-cmd\fR]
 [\fB\-N\fR \fInon-priv-cmd\fR]
 [\fB\-p\fR \fIplatform\fR]
@@ -180,11 +192,11 @@ index holds enough information to support an automated build process by
 \&\fBopenpkg build\fR.
 .PP
 The following command line options exist:
-.IP "\fB\-r\fR \fIresource\fR" 4
+.Ip "\fB\-r\fR \fIresource\fR" 4
 .IX Item "-r resource"
 The name of the resource stored in the index. The default is
 "\f(CW\*(C`OpenPKG\-CURRENT/Source/\*(C'\fR".
-.IP "\fB\-p\fR \fIplatform\fR" 4
+.Ip "\fB\-p\fR \fIplatform\fR" 4
 .IX Item "-p platform"
 \&\fBopenpkg index\fR adds a platform attribute for binary RPMs. The
 attribute is built as \fI%{arch}\fR\f(CW\*(C`\-\*(C'\fR\fIplatform\fR\f(CW\*(C`\-\*(C'\fR\fI%{os}\fR where
@@ -192,19 +204,19 @@ attribute is built as \fI%{arch}\fR\f(CW\*(C`\-\*(C'\fR\fIplatform\fR\f(CW\*(C`\
 the value of the \fB\-p\fR option. The default value is "\f(CW\*(C`unknown\*(C'\fR". This
 must be used to distinguish between platforms that support the same
 Architecture and \s-1OS\s0 name like various Linux distributions.
-.IP "\fB\-C\fR \fIcache.db\fR" 4
+.Ip "\fB\-C\fR \fIcache.db\fR" 4
 .IX Item "-C cache.db"
 Cache all \fI.spec\fR files into this Berkeley-DB file when indexing source
 RPMs. The cache is refreshed automatically when the source RPMs are more
 recent than the cache entry.
-.IP "\fB\-o\fR \fIindex.rdf\fR" 4
+.Ip "\fB\-o\fR \fIindex.rdf\fR" 4
 .IX Item "-o index.rdf"
 Name of the output \s-1XML/RDF\s0 file, default is to write to \fIstdout\fR.
-.IP "\fB\-c\fR" 4
+.Ip "\fB\-c\fR" 4
 .IX Item "-c"
 Compress output with \f(CW\*(C`bzip2\*(C'\fR. Use the \fB\-o\fR option to specify a \fI.bz2\fR
 suffix.
-.IP "\fB\-i\fR" 4
+.Ip "\fB\-i\fR" 4
 .IX Item "-i"
 The specified directories are \s-1RPM\s0 repositories. Build index over
 all \fI.rpm\fR files in these directories and all subdirectories.
@@ -223,62 +235,109 @@ on the upgraded package (\*(L"reverse dependencies\*(R"). The dependency
 information is read from an index generated by \fBopenpkg index\fR.
 .PP
 The following command line options exist:
-.IP "\fB\-R\fR \fIrpm\fR" 4
+.Ip "\fB\-R\fR \fIrpm\fR" 4
 .IX Item "-R rpm"
 Specify a path to the installed \fBOpenPKG\fR \f(CW\*(C`rpm\*(C'\fR executable. Several
 other internal paths are deduced from the \fIrpm\fR path, so this should be
 something like \fI%{l_prefix}\fR\f(CW\*(C`/bin/rpm\*(C'\fR.
-.IP "\fB\-r\fR \fIrepository\fR" 4
+.Ip "\fB\-r\fR \fIrepository\fR" 4
 .IX Item "-r repository"
 Specify a path to an \s-1RPM\s0 repository, this can be a \s-1URL\s0 or a directory
 path. The name of the package file is appended to this path.
 The default is to use a \s-1URL\s0 pointing to the \fBOpenPKG\fR \s-1FTP\s0 server.
-.IP "\fB\-f\fR \fIindex.rdf\fR" 4
+.Ip "\fB\-f\fR \fIindex.rdf\fR" 4
 .IX Item "-f index.rdf"
 Specify a path to the primary \s-1XML/RDF\s0 index, this can be a \s-1URL\s0 or a
 file path. If the index contains references to aother indexes these are
 included automatically. The default is to use a \s-1URL\s0 pointing to the
 \&\fBOpenPKG\fR \s-1FTP\s0 server for the \fBOpenPKG\fR release you are using.
-.IP "\fB\-u\fR" 4
+.Ip "\fB\-u\fR" 4
 .IX Item "-u"
 The generated script will ignore binary RPMs that are stored on
 your system. Instead it will either fetch binary RPMs or rebuild
 from source RPMs fetched from the repository.
-.IP "\fB\-U\fR" 4
+.Ip "\fB\-U\fR" 4
 .IX Item "-U"
 The generated script will try to upgrade all selected packages
 including their dependencies to the most recent version.
-.IP "\fB\-z\fR" 4
+.Ip "\fB\-z\fR" 4
 .IX Item "-z"
 The generated script will rebuild all selected packages
 including their dependencies even when the most recent version
 is already installed.
-.IP "\fB\-Z\fR" 4
+.Ip "\fB\-Z\fR" 4
 .IX Item "-Z"
 \&\fBopenpkg build\fR ignores all installed packages, the
 script will rebuild all selected packages from scratch. 
 Note that this doesn't work together with the \fB\-a\fR option.
-.IP "\fB\-i\fR" 4
+.Ip "\fB\-i\fR" 4
 .IX Item "-i"
 The generated script will ignore errors. However, if a build
 phase fails the install phase is still skipped.
-.IP "\fB\-q\fR" 4
+.Ip "\fB\-q\fR" 4
 .IX Item "-q"
 Ignore all reverse dependencies.
 \&\fI\s-1ATTENTION:\s0 this might break already installed packages!\fR
-.IP "\fB\-P\fR \fIpriv-cmd\fR" 4
+.Ip "\fB\-s\fR" 4
+.IX Item "-s"
+Print a status map instead of the install script. The map consists
+of 3 columns: \*(L"old\*(R", \*(L"tag\*(R" and \*(L"new\*(R". \*(L"old\*(R" shows the installed
+version of a package or just the package name if no package of
+that name is installed and \*(L"new\*(R" shows the repository version
+of a package if it is considered for installation. \*(L"tag\*(R" has the
+following possible values:
+.RS 4
+.Ip "\s-1OK\s0" 4
+.IX Item "OK"
+The installed package is suitable and will not be touched.
+.Ip "\s-1ADD\s0" 4
+.IX Item "ADD"
+There is no installed package yet.
+.Ip "\s-1UPGRADE\s0" 4
+.IX Item "UPGRADE"
+The installed package is outdated and requires an update.
+.Ip "\s-1DEPEND\s0" 4
+.IX Item "DEPEND"
+The installed package needs rebuilding because one of its
+dependencies is rebuilt.
+.Ip "\s-1MISMATCH\s0" 4
+.IX Item "MISMATCH"
+The installed package needs rebuilding because it was build
+with different parameters.
+.Ip "\s-1CONFLICT\s0" 4
+.IX Item "CONFLICT"
+The required new package cannot be installed because it
+conflicts with some already installed package.
+.Ip "\s-1UNDEF\s0" 4
+.IX Item "UNDEF"
+The package has an invalid or ambigous dependency.
+.RE
+.RS 4
+.RE
+.Ip "\fB\-S\fR" 4
+.IX Item "-S"
+Similar to \fB\-s\fR but also lists the newest versions in the
+repository. The following tag might appear in the map.
+.RS 4
+.Ip "\s-1NEW\s0" 4
+.IX Item "NEW"
+The package exists in the repository but isn't required yet.
+.RE
+.RS 4
+.RE
+.Ip "\fB\-P\fR \fIpriv-cmd\fR" 4
 .IX Item "-P priv-cmd"
 Command prefix to use for install commands that require elevated
-privileges. The most common tool for this is \fIsudo\fR\|(1).
-.IP "\fB\-N\fR \fInon-priv-cmd\fR" 4
+privileges. The most common tool for this is \fIsudo\fR\|(8).
+.Ip "\fB\-N\fR \fInon-priv-cmd\fR" 4
 .IX Item "-N non-priv-cmd"
 Command prefix to use for install commands that do not require elevated
-privileges. The most common tool for this is \fIsudo\fR\|(1).
-.IP "\fB\-p\fR \fIplatform\fR" 4
+privileges. The most common tool for this is \fIsudo\fR\|(8).
+.Ip "\fB\-p\fR \fIplatform\fR" 4
 .IX Item "-p platform"
 The platform string that is matched against the index for binary
 packages. Default is to use the \fI%{_target_platform}\fR variable.
-.IP "\fB\-D\fR\fIvar\fR=\fIval\fR" 4
+.Ip "\fB\-D\fR\fIvar\fR=\fIval\fR" 4
 .IX Item "-Dvar=val"
 Specify configuration options for all selected packages. This can be
 either \fB\-D\fR\f(CW\*(C`with_\*(C'\fR\fIxxx\fR\f(CW\*(C`=\*(C'\fR\fIyyy\fR or just \fB\-D\fR\f(CW\*(C`with_\*(C'\fR\fIxxx\fR, the
@@ -286,16 +345,16 @@ latter is equivalent to a \fB\-D\fR\f(CW\*(C`with_\*(C'\fR\fIxxx\fR\f(CW\*(C`=\*
 are matched against selected packages that are already installed. If
 they do indicate a change the package is rebuild. There can be multiple
 \&\fB\-D\fR options.
-.IP "\fB\-E\fR \fIname\fR" 4
+.Ip "\fB\-E\fR \fIname\fR" 4
 .IX Item "-E name"
 Ignore a package with the specified \fIname\fR. This can be used to avoid
 upgrading to a broken package in the repository. There can be multiple
 \&\fB\-E\fR options.
-.IP "\fB\-a\fR" 4
+.Ip "\fB\-a\fR" 4
 .IX Item "-a"
 Select all installed packages. Do not specify a pattern list together
 with the \fB\-a\fR option.
-.IP "\fB\-A\fR" 4
+.Ip "\fB\-A\fR" 4
 .IX Item "-A"
 Select all packages in the repository. Do not specify a pattern list together
 with the \fB\-a\fR option.
@@ -311,13 +370,13 @@ define default options for multiple \fBOpenPKG\fR hierarchies.
 Parallel execution of \fBopenpkg build\fR causes undefined effects.
 .SH "SEE ALSO"
 .IX Header "SEE ALSO"
-\&\fIrpm\fR\|(1), \fIsudo\fR\|(1)
+\&\fIrpm\fR\|(8), \fIsudo\fR\|(8)
 .SH "HISTORY"
 .IX Header "HISTORY"
 The \fBopenpkg index\fR and \fBopenpkg build\fR command
 was invented in November 2002 by \fIMichael van Elst\fR
 <mlelstv@dev.de.cw.net> under contract with \fICable & Wireless
-Germany\fR <http://www.cw.com/de> for use inside the \fBOpenPKG\fR
+Germany\fR <http://www.cw.com/de/> for use inside the \fBOpenPKG\fR
 project <http://www.openpkg.org/>.
 .SH "AUTHORS"
 .IX Header "AUTHORS"

+ 4 - 4
openpkg-tool/openpkg.pod

@@ -252,12 +252,12 @@ The package exists in the repository but isn't required yet.
 =item B<-P> I<priv-cmd>
 
 Command prefix to use for install commands that require elevated
-privileges. The most common tool for this is sudo(1).
+privileges. The most common tool for this is sudo(8).
 
 =item B<-N> I<non-priv-cmd>
 
 Command prefix to use for install commands that do not require elevated
-privileges. The most common tool for this is sudo(1).
+privileges. The most common tool for this is sudo(8).
 
 =item B<-p> I<platform>
 
@@ -305,14 +305,14 @@ Parallel execution of B<openpkg build> causes undefined effects.
 
 =head1 SEE ALSO
 
-rpm(1), sudo(1)
+rpm(8), sudo(8)
 
 =head1 HISTORY
 
 The B<openpkg index> and B<openpkg build> command
 was invented in November 2002 by I<Michael van Elst>
 E<lt>mlelstv@dev.de.cw.netE<gt> under contract with I<Cable & Wireless
-Germany> E<lt>http://www.cw.com/deE<gt> for use inside the B<OpenPKG>
+Germany> E<lt>http://www.cw.com/de/E<gt> for use inside the B<OpenPKG>
 project E<lt>http://www.openpkg.org/E<gt>.
 
 =head1 AUTHORS