From 3268f03e41d0802a3d2fe6845320b002f8ef3421 Mon Sep 17 00:00:00 2001 From: Hartmut Goebel Date: Tue, 25 Nov 2014 01:04:29 +0100 Subject: Group options by purpose and add sub-headlines for each group. The urpmi tools share a lot of options like download options, media selections and so on. Other option groups are package selection, output options (for urpmf, urpmq) and database options. Grouping them makes it easier for the user to spot what she needs. Additionally tool-specific groups will be put near the top of the options section, while common groups will be put near the end of that list, followed by rarely used stuff like debugging. This makes it easier for the user to spot the tool-specific parts. Grouping may not be perfect and some option may be in a group not matching 100 percent. But anyway this should be a fairly good state. followed --- pod/8/urpmq.pod | 277 ++++++++++++++++++++++++++++++++------------------------ 1 file changed, 159 insertions(+), 118 deletions(-) (limited to 'pod/8/urpmq.pod') diff --git a/pod/8/urpmq.pod b/pod/8/urpmq.pod index 577505a1..33fed7db 100644 --- a/pod/8/urpmq.pod +++ b/pod/8/urpmq.pod @@ -24,6 +24,21 @@ according to the command-line options that were used: Prints a help message and exit. +=item B<-v>, B<--verbose> + +Activate verbose mode. + + +=item B<--force> + +Continue when requesting packages that are not available. + +=back + +=head2 Operation Modes + +=over + =item B<--list> List available packages. @@ -46,38 +61,13 @@ List available nodes for parallel installation (when using B<--parallel>). List available parallel aliases. -=item B<--update> - -Use only update media. This means that urpmq will search and resolve -dependencies only in media marked as containing updates (e.g. which have -been created with C). - -=item B<--media> I - -Select specific media to be used, instead of defaulting -to all available media (or all update media if B<--update> is used). -No rpm will be found in other media. - -=item B<--excludemedia> I - -Do not use the specified media. - -=item B<--searchmedia> I - -Use only the specified media to search for packages that are specified on -the command-line, or which are found when using B<--auto-select>. -Dependencies of those packages can still be found in other media. -=item B<--sortmedia> I -Sort the specified media. Substrings may be used to simplify grouping. -This way, C will be taken into account first, then C, and -so on. Media which aren't listed are taken into account after the others. +=back -=item B<--synthesis> I +=head2 Package Selection -Use the specified synthesis file instead of the urpmi database for -searching packages and resolving dependencies. +=over =item B<--auto-select> @@ -127,97 +117,70 @@ Like B<-y>/B<--fuzzy>, but forces to match case-insensitively. Search a source package matching I and it will select all dependencies by default. -=item B<--sources> - -Prints source URLs (or file names) of all selected -packages. - -=item B<--force> - -Continue when requesting packages that are not available. - =item B<--ignorearch> Allow to search packages whose architecture isn't compatible with the architecture of the host. -=item B<--parallel> I +=item B<-u> -Activate distributed execution of urpmi to other machines (it is mandatory -that urpmi is installed but it is not necessary to have media defined on -any machines). I defines which extension module to use by urpmi -(currently urpmi-parallel-ka-run or urpmi-parallel-ssh) and which -machines should be updated, this alias is defined in the file -F as described below. +Deselect packages if a better version is already installed. -=item B<--root> I +=item B<-m> -Use the file system tree rooted for rpm install. All operations and -scripts will run after chroot(2). The rpm database in the rooted tree -will be used but urpmi configuration comes from normal system. +Equivalent to B<-du>. -=item B<--urpmi-root> I +=item B<-a> -Use the file system tree rooted for urpmi database and rpm install. Contrary -to B<--root>, the urpmi configuration comes from the rooted tree. +Select all matches on command line; that's useful when one gives an +incomplete package name and when using B<-f> or B<-r>. -=item B<--wget> +=item B<-c> -Use wget for downloading distant files. By default curl -is used if available, or wget instead. +If maximal closure is used, assume that a package listed may have wrong or +not up-to-date dependencies. This causes more packages to be upgraded and +may correct unresolved dependencies on the rpm database. -=item B<--curl> -Use curl for downloading distant files. By default curl is used if -available, or wget instead. +=item B<-p>, B<--whatprovides> -=item B<--curl-options> I<'options'> +Search in provides to find package. -=item B<--rsync-options> I<'options'> +=item B<--whatrequires> -=item B<--wget-options> I<'options'> +Reverse search to what requires the package given. -Specify additional command-line options to be passed to curl, rsync or -wget when retrieving files. If several options are to be passed, separate -them with spaces and enclose them in quotes. +=item B<--whatrequires-recursive> -Note that the rsync options will also be used for ssh media. +Reverse search to what requires recursively the package given +(looking through virtual packages). -=item B<--proxy> I +=back -Use specified HTTP proxy. +=head2 Output Options -=item B<--proxy-user> I +=over -Use specified user and password to use for proxy authentication. -Specifying B<--proxy-user=ask> will cause urpmq to prompt for a username -and a password. -=item B<--use-distrib> I +=item B<-i> -Configure urpmq on the fly from a distribution tree. +Prints useful information in human readable form, as for I. -=item B<--env> I +=item B<-g> -Use a different environment directly from a bug report to replay a bug. -The argument is the same argument given to B<--bug> option. +Prints groups of each package listed. -=item B<--skip> I +=item B<-r> -You can specify a list of packages which installation should be skipped. -You can also include patterns between //, just like in -F (see urpmi.files(5)). +Prints also version and release of each package listed. -=item B<--prefer> I +=item B<-f> -You can specify a list of packages which installation should be preferred -(especially useful with B<--auto>). -You can also include patterns between //, just like in -F (see urpmi.files(5)). +Prints also version, release and arch of each package listed. -=item B<--wait-lock> +=item B<-l> -If the urpmi or rpm db is busy, wait until it is available +Lists files in packages. =item B<--changelog> @@ -243,6 +206,11 @@ Prints the package requires. Prints the package suggests. +=item B<--sources> + +Prints source URLs (or file names) of all selected +packages. + =item B<--sourcerpm> Prints the sourcerpm of the package @@ -251,65 +219,138 @@ Prints the sourcerpm of the package Prints concise information about the package. -=item B<-v>, B<--verbose> +=item B<-d>, B<--requires-recursive> -Activate verbose mode. +Print dependencies (maximal closure). -=item B<-u> -Deselect packages if a better version is already installed. +=back -=item B<-m> +=head2 Media Selection -Equivalent to B<-du>. +=over -=item B<-a> +=item B<--update> -Select all matches on command line; that's useful when one gives an -incomplete package name and when using B<-f> or B<-r>. +Use only update media. This means that urpmq will search and resolve +dependencies only in media marked as containing updates (e.g. which have +been created with C). -=item B<-c> +=item B<--media> I -If maximal closure is used, assume that a package listed may have wrong or -not up-to-date dependencies. This causes more packages to be upgraded and -may correct unresolved dependencies on the rpm database. +Select specific media to be used, instead of defaulting +to all available media (or all update media if B<--update> is used). +No rpm will be found in other media. -=item B<-d>, B<--requires-recursive> +=item B<--excludemedia> I -Print dependencies (maximal closure). +Do not use the specified media. -=item B<-p>, B<--whatprovides> +=item B<--searchmedia> I -Search in provides to find package. +Use only the specified media to search for packages that are specified on +the command-line, or which are found when using B<--auto-select>. +Dependencies of those packages can still be found in other media. -=item B<--whatrequires> +=item B<--sortmedia> I -Reverse search to what requires the package given. +Sort the specified media. Substrings may be used to simplify grouping. +This way, C will be taken into account first, then C, and +so on. Media which aren't listed are taken into account after the others. -=item B<--whatrequires-recursive> +=item B<--synthesis> I -Reverse search to what requires recursively the package given -(looking through virtual packages). +Use the specified synthesis file instead of the urpmi database for +searching packages and resolving dependencies. -=item B<-i> +=item B<--parallel> I -Prints useful information in human readable form, as for I. +Activate distributed execution of urpmi to other machines (it is mandatory +that urpmi is installed but it is not necessary to have media defined on +any machines). I defines which extension module to use by urpmi +(currently urpmi-parallel-ka-run or urpmi-parallel-ssh) and which +machines should be updated, this alias is defined in the file +F as described below. -=item B<-g> +=item B<--root> I -Prints groups of each package listed. +Use the file system tree rooted for rpm install. All operations and +scripts will run after chroot(2). The rpm database in the rooted tree +will be used but urpmi configuration comes from normal system. -=item B<-r> +=item B<--urpmi-root> I -Prints also version and release of each package listed. +Use the file system tree rooted for urpmi database and rpm install. Contrary +to B<--root>, the urpmi configuration comes from the rooted tree. -=item B<-f> -Prints also version, release and arch of each package listed. +=item B<--use-distrib> I -=item B<-l> +Configure urpmq on the fly from a distribution tree. + +=item B<--skip> I + +You can specify a list of packages which installation should be skipped. +You can also include patterns between //, just like in +F (see urpmi.files(5)). + +=item B<--prefer> I + +You can specify a list of packages which installation should be preferred +(especially useful with B<--auto>). +You can also include patterns between //, just like in +F (see urpmi.files(5)). + + +=back + +=head2 Download Options + +=over + +=item B<--wget> + +Use wget for downloading distant files. By default curl +is used if available, or wget instead. + +=item B<--curl> + +Use curl for downloading distant files. By default curl is used if +available, or wget instead. + +=item B<--curl-options> I<'options'> + +=item B<--rsync-options> I<'options'> + +=item B<--wget-options> I<'options'> + +Specify additional command-line options to be passed to curl, rsync or +wget when retrieving files. If several options are to be passed, separate +them with spaces and enclose them in quotes. + +Note that the rsync options will also be used for ssh media. + +=item B<--proxy> I + +Use specified HTTP proxy. + +=item B<--proxy-user> I + +Use specified user and password to use for proxy authentication. +Specifying B<--proxy-user=ask> will cause urpmq to prompt for a username +and a password. + +=back + +=head2 Debugging Options + +=over + +=item B<--env> I + +Use a different environment directly from a bug report to replay a bug. +The argument is the same argument given to B<--bug> option. -Lists files in packages. =back -- cgit v1.2.1