aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Dolbec <dolsen@gentoo.org>2015-02-28 15:45:29 -0800
committerBrian Dolbec <dolsen@gentoo.org>2015-03-04 12:38:05 -0800
commit44f2a48390909050dd42404de9136bf78c97928e (patch)
tree4215b90b10368063d9028541e22147e4d231fc2f
parentDon't spawn socks5-server.py for pkg_nofetch (bug 542052) (diff)
downloadportage-44f2a48390909050dd42404de9136bf78c97928e.tar.gz
portage-44f2a48390909050dd42404de9136bf78c97928e.tar.bz2
portage-44f2a48390909050dd42404de9136bf78c97928e.zip
emaint.1: Update man page for better clarity (540482)
As recommended by Duncan on the gentoo-portage-dev list. Clarify the all command. Add OPTIONS to all commands, so a user can determine which modules may run when the 'all' command is used. Remove repetitive '(* command only)' text by adding it to the section header.
-rw-r--r--man/emaint.143
1 files changed, 30 insertions, 13 deletions
diff --git a/man/emaint.1 b/man/emaint.1
index c97945fba..9d8de55fc 100644
--- a/man/emaint.1
+++ b/man/emaint.1
@@ -12,75 +12,92 @@ management health checks and maintenance.
.SH COMMANDS
.TP
.BR all
-Perform all supported commands.
+Perform all supported commands that accept the specified option.
.TP
.BR binhost
Generate a metadata index for binary packages located in \fBPKGDIR\fR (for
download by remote clients). See the \fBPORTAGE_BINHOST\fR documentation in
the \fBmake.conf\fR(5) man page for additional information.
+.br
+OPTIONS: check, fix
.TP
.BR cleanconfig
Discard no longer installed config tracker entries.
+.br
+OPTIONS: check, fix
.TP
.BR cleanresume
Discard merge lists saved for the \fBemerge\fR(1) \fB--resume\fR action.
+.br
+OPTIONS: check, fix
.TP
.BR logs
Clean out old logs from the \fBPORT_LOGDIR\fR using the command
\fBPORT_LOGDIR_CLEAN\fR
See the \fBmake.conf\fR(5) man page for additional information as well as
enabling the \fB'clean-logs'\fR feature in emerge to do this automatically.
+.br
+OPTIONS: check, clean
.TP
.BR merges
Scan for failed package merges and attempt to fix those failed packages.
+.br
+OPTIONS: check, fix, purge
.TP
.BR movebin
Perform package move updates for binary packages located in \fBPKGDIR\fR.
+.br
+OPTIONS: check, fix
.TP
.BR moveinst
Perform package move updates for installed packages.
+.br
+OPTIONS: check, fix
.TP
.BR sync
Perform sync actions on specified repositories.
+.br
+OPTIONS: allrepos, auto, repo
.TP
.BR world
Fix problems in the \fIworld\fR file.
-.SH DEFAULT OPTIONS
+.br
+OPTIONS: check, fix
+.SH DEFAULT OPTIONS (Not supported in all commands)
.TP
.B \-c, \-\-check
-Check for any problems that may exist. (all commands)
+Check for any problems that may exist.
.TP
.B \-f, \-\-fix
-Fix any problems that may exist. (not all commands)
-.SH OPTIONS logs command
+Fix any problems that may exist.
+.SH OPTIONS logs command only
.TP
.B \-C, \-\-clean
-Cleans the logs from \fBPORT_LOGDIR\fR (logs command only)
+Cleans the logs from \fBPORT_LOGDIR\fR
.TP
.B \-p, \-\-pretend
Sets pretend mode (same as \-c, \-\-check) for use with the \-C, \-\-clean
-OPTION (logs command only)
+OPTION
.TP
.B \-t NUM, \-\-time NUM
Changes the minimum age \fBNUM\fR (in days) of the logs to be listed or
-deleted. (logs command only)
-.SH OPTIONS sync command
+deleted.
+.SH OPTIONS sync command only
.TP
.B \-a, \-\-auto
-Sync repositories which have its auto\-sync setting set yes, true. (sync command only)
+Sync repositories which have its auto\-sync setting set yes, true.
.TP
.B \-A, \-\-allrepos
-Sync all repositories which have a sync\-uri specified. (sync command only)
+Sync all repositories which have a sync\-uri specified.
.TP
.B \-r, \-\-repo REPO
-Sync the repository specified. (sync command only)
+Sync the repository specified.
.TP
.BR "\-\-sync-submodule <glsa|news|profiles>"
Restrict sync to the specified submodule(s). This option may be
specified multiple times, in order to sync multiple submodules.
Currently, this option has no effect for sync protocols other
than rsync.
-(sync command only)
.SH "REPORTING BUGS"
Please report bugs via http://bugs.gentoo.org/
.SH AUTHORS