[Yum] yum-arch documentation patch.

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, 27 Aug 2003, seth vidal wrote:

> > Error moving headers to .oldheaders, fatal
> 
> 
> yum-arch doesn't need to run as root, in fact, I almost never run it as
> root.

While discussing yum-arch, a very trivial point on the documentation.

See the patch below, which says it all (and even adds the observation
that you don't need to run yum-arch as root:-).

The Usage in the tool itself should possibly be changed as well.  

  rgb
 
-- 
Robert G. Brown	                       http://www.phy.duke.edu/~rgb/
Duke University Dept. of Physics, Box 90305
Durham, N.C. 27708-0305
Phone: 1-919-660-2567  Fax: 919-660-2525     email:rgb@xxxxxxxxxxxx


--- yum-arch.8	2003-08-28 09:33:26.000000000 -0400
+++ yum-arch-new.8	2003-08-28 10:06:59.000000000 -0400
@@ -3,7 +3,7 @@
 .SH "NAME"
 yum\-arch \- Creates yum distribution database
 .SH "SYNOPSIS"
-\fByum\-arch\fP [options] directory
+\fByum\-arch\fP [options] header_dir repository_dir
 .PP 
 .SH "DESCRIPTION"
 \fByum\-arch\fP is run from the distribution site in order to create the
@@ -27,8 +27,26 @@
 .IP "\fB\-l\fP"
 pay attention to symlinks (Default is to ignore symlinks).
 .br 
-.IP "\fBdirectory\fP"
-a directory where you want to create the \fIheaders\fP directory.
+.IP "\fBheader_dir\fP"
+is the \fIheaders\fP directory.  It will be created in the toplevel
+repository directory (next) if it does not already exist or updated if
+it does.
+.IP "\fBrepository_dir\fP"
+is the actual repository directory.  The RPMS to be yum-distributed can
+be on any path within this directory - yum-arch will search the local
+tree.
+
+.SH "EXAMPLES"
+A example of the use of yum-arch with the defaults is as follows:
+
+  # cd /path/to/repository
+  # yum-arch headers .
+
+It is neither necessary nor desirable to run yum-arch as root as long as
+the user that runs it has permission to read the repository and write
+the header files.
+.fi 
+.PP 
 
 .SH "FILES"
 .nf 


[Index of Archives]     [Fedora Users]     [Fedora Legacy List]     [Fedora Maintainers]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]

  Powered by Linux