More man page fixes Bug #74944

svn path=/; revision=234

diff --git a/trunk/src/equery/equery.1 b/trunk/src/equery/equery.1
index b671a26778816d4d9bfd8d8474dd346b156df13f..748bc47a6773dcb2a0b22cb48727eab3af9452f8 100644 (file)
--- a/trunk/src/equery/equery.1
+++ b/trunk/src/equery/equery.1
@@ -1,18 +1,17 @@
-.TH equery "1" "Jan 2004" "gentoolkit"
-.SH NAME
+.TH "equery" "1" "Jan 2004" "gentoolkit" ""
+.SH "NAME"
 equery \- Gentoo: Package Query Tool
-.SH SYNOPSIS
+.SH "SYNOPSIS"
 .B equery  
 .I [global\-opts] command [local\-opts]
-.PP
-
-.SH DESCRIPTION
+.PP 
 
+.SH "DESCRIPTION"
 equery is a flexible utility which may display various information about 
 packages, such as the files they own, their USE flags, the md5sum 
 of each file owned by a given package, and many other things.
 
-.SH OPTIONS
+.SH "OPTIONS"
 The 'command' is the only mandatory option to equery.  Most commands require
 a 'pkgspec' option, which is described by <cat/>packagename<\-version>;
 namely, the package name is mandatory, while the category and version are 
@@ -22,132 +21,160 @@ optional.
 
 .B \-q, \-\-quiet   
 causes minimal output to be emitted
-.PP
+.PP 
 .B \-C, \-\-nocolor 
 turns off colours
-.PP
+.PP 
 .B \-h, \-\-help
 displays a help summary
-.PP
+.PP 
 .B \-V, \-\-version
 displays the equery version
-.PP
+.PP 
 
 Only one command will actually be run, at most.  The possible commands are: 
-.TP
+.TP 
 .B belongs <local\-opts> file
 This command lists all packages owning the specified file.
-.br
+.br 
 Note: Normally, only one package will own a file. If multiple packages own the
 same file, it usually consitutes a problem, and should be reported.
-.br
-.IP
+.br 
+.IP 
 <local\-opts> is either or both of:
-.br
+.br 
 .B \-c, \-\-category cat 
 only search in category cat
-.br
+.br 
+.B \-f, \-\-full\-regex
+supplied query is a regex
+.br 
 .B \-e, \-\-earlyout 
 stop when first match found
 
-.PP
+.PP 
 .B check pkgspec
 This command checks the files of the specified package against recorded MD5 
 sums and timestamps.
-.PP
-.TP
+.PP 
+.TP 
 .B depends <local\-opts> pkgspec
 This command displays all dependencies matching pkgspec.
-.br
+.br 
 <local\-opts> is either or both of:
-.br
-.B \-a, \-\-all-packages
+.br 
+.B \-a, \-\-all\-packages
 search in all available packages (slow)
-.br
+.br 
 .B \-d, \-\-direct
 search direct dependencies only (default)
-.br
+.br 
 .B \-D, \-\-indirect
 search indirect dependencies (very slow)
-.PP
-.TP
+.PP 
+.TP 
 .B depgraph <local\-opts> pkgspec
 This command display a dependency tree for pkgspec, by default indented to reflect
 how dependancies relate to each other.
-.br
+.br 
+.IP 
 <local\-opts> is either or both of:
-.br
+.br 
 .B \-U, \-\-no\-useflags 
-do not show USE flags.  Note that this doesn't actually do anything, as USE flags
-are not shown even without this option.
-.br
+do not show USE flags.
+.br 
 .B \-l, \-\-linear    
 do not use fancy formatting 
-.PP
-.TP
+.PP 
+.TP 
 .B files <local\-opts> pkgspec
 This lists files owned by a particular package, optionally with extra
 information specified by <local\-opts>
-.br
+.br 
 
 <local\-opts> is any combination of:
-.br
+.br 
 .B \-\-timestamp
 output the timestamp of each file
-.br
+.br 
 .B \-\-md5sum
 output the md5sum of each file
-.br
+.br 
 .B \-\-type
 output the type of each file
-.br
+.br 
 .B \-\-filter=<rules>
 filter output based on files type or path
-.br
+.br 
 .B \t<rules>
 is a comma separated list of filtering rules. Available rules are:
-.br
+.br 
 .B \t\tdir\ 
 regular directories
-.br
+.br 
 .B \t\tobj\ 
 regular files
-.br
+.br 
 .B \t\tsym\ 
 symbolic links
-.br
+.br 
 .B \t\tdev\ 
 device nodes
-.br
+.br 
 .B \t\tfifo
 named pipes
-.br
+.br 
 .B \t\tpath
 shortest paths where some files where installed
-.br
+.br 
 .B \t\tconf
 configuration files (based on $CONFIG_PROTECT)
-.br
+.br 
 .B \t\tcmd\ 
 user commands (based on $PATH)
-.br
+.br 
 .B \t\tdoc\ 
 documentation files (from /usr/share/doc)
-.br
+.br 
 .B \t\tman\ 
 manpages (from /usr/share/man)
-.br
+.br 
 .B \t\tinfo
 info pages (from /usr/share/info)
-.PP
-.TP
+.PP 
+.TP 
+.B hasuse <local\-opts> useflag
+This command lists packages matching a particular USE flag in a user\-specified combination
+of installed packages, packages which are not installed, the portage tree, and
+the portage overlay tree.
+
+<local\-opts> must not include only \-I;
+if \-I is used, \-p and/or \-o must be also be present.  By default, only installed
+packages are searched.  \-o searches only the overlay tree [and possibly
+installed packages],
+.I not
+the main portage tree.
+
+.B \-i, \-\-installed
+search installed packages (default)
+.br 
+.B \-I, \-\-exclude\-installed
+do not search installed packages
+.br 
+.B \-p, \-\-portage\-tree
+also search in portage tree (/usr/portage)
+.br 
+.B \-o, \-\-overlay\-tree
+also search in overlay tree (/usr/local/portage)
+.PP 
+.TP 
 .B list <local\-opts> pkgspec
 This command lists packages matching pkgspec in a user\-specified combination
 of installed packages, packages which are not installed, the portage tree, and
 the portage overlay tree.
 
-<local\-opts> must include not include only \-I;
-if \-I is used, \-p and/or \-o must be also.  By default, only installed
+<local\-opts> must not include only \-I;
+if \-I is used, \-p and/or \-o must be alsobe present.  By default, only installed
 packages are searched.  \-o searches only the overlay tree [and possibly
 installed packages],
 .I not
@@ -155,50 +182,55 @@ the main portage tree.
 
 .B \-i, \-\-installed
 search installed packages (default)
-.br
+.br 
 .B \-I, \-\-exclude\-installed
 do not search installed packages
-.br
+.br 
 .B \-p, \-\-portage\-tree
 also search in portage tree (/usr/portage)
-.br
+.br 
 .B \-o, \-\-overlay\-tree
 also search in overlay tree (/usr/local/portage)
-.PP
-.TP
+.PP 
+.TP 
 .B size <local\-opts> pkgspec
 This command outputs the number of files in the specified package, as well as
 their total size in an appropriate unit.
 
 The only possible value for <local\-opts>, if specified, is:
-.br
+.br 
 .B \-b, \-\-bytes 
 report size in bytes
-.PP
-.TP
+.PP 
+.TP 
 .B uses <local\-opts> pkgspec 
-display USE flags for pkgspec.  No local options are actually implemented yet.
-.PP
+display USE flags for pkgspec.
+
+The only possible value for <local\-opts>, if specified, is:
+.br 
+.B \-a, \-\-all
+include non\-installed packages
+.PP 
 .B which pkgspec 
 print full path to ebuild for package pkgspec
-.PP
+.PP 
 
-.SH Unimplemented Options
-.PP
+.SH "Unimplemented Options"
+.PP 
 .B changes
-.PP
+.PP 
 .B glsa \fR \- use glsa\-check for the time being.
-.PP
+.PP 
 .B stats
 
 
 
-.SH BUGS
+.SH "BUGS"
 Many options aren't implemented.  Command\-line parsing could use some work. 
-.br
+.br 
 Submit bug reports to http://bugs.gentoo.org
-.SH AUTHORS
+.SH "AUTHORS"
 equery, original man page: Karl Trygve Kalleberg <karltk@gentoo.org>, 2003.
-.br
+.br 
 Massive man page updates: Katerina Barone\-Adesi <katerinab@gmail.com>, 2004.