Bug 1706131 - dnf module <command> level help
Summary: dnf module <command> level help
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: dnf
Version: 30
Hardware: Unspecified
OS: Unspecified
medium
unspecified
Target Milestone: ---
Assignee: rpm-software-management
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-05-03 15:33 UTC by Jun Aruga
Modified: 2019-12-17 13:15 UTC (History)
10 users (show)

Fixed In Version:
Clone Of:
Environment:
Last Closed: 2019-12-17 13:15:11 UTC
Type: Bug
Embargoed:


Attachments (Terms of Use)

Description Jun Aruga 2019-05-03 15:33:06 UTC
Description of problem:

"dnf module <command> --help" shows all the commands help.
But I want to see only specified <command>'s help.

"dnf module install --help" shows only a help of "dnf module install".


```
$ dnf module install --help
usage: dnf module [-c [config file]] [-q] [-v] [--version]
                  [--installroot [path]] [--nodocs] [--noplugins]
                  [--enableplugin [plugin]] [--disableplugin [plugin]]
                  [--releasever RELEASEVER] [--setopt SETOPTS] [--skip-broken]
                  [-h] [--allowerasing] [-b | --nobest] [-C] [-R [minutes]]
                  [-d [debug level]] [--debugsolver] [--showduplicates]
                  [-e ERRORLEVEL] [--obsoletes]
                  [--rpmverbosity [debug level name]] [-y] [--assumeno]
                  [--enablerepo [repo]] [--disablerepo [repo] | --repo [repo]]
                  [--enable | --disable] [-x [package]]
                  [--disableexcludes [repo]] [--repofrompath [repo,path]]
                  [--noautoremove] [--nogpgcheck] [--color COLOR] [--refresh]
                  [-4] [-6] [--destdir DESTDIR] [--downloadonly]
                  [--comment COMMENT] [--bugfix] [--enhancement]
                  [--newpackage] [--security] [--advisory ADVISORY]
                  [--bz BUGZILLA] [--cve CVES]
                  [--sec-severity {Critical,Important,Moderate,Low}]
                  [--forcearch ARCH]
                  [--enabled | --disabled | --installed | --profile]
                  {list,update,install,reset,disable,enable,provides,info,remove}
                  [module-spec [module-spec ...]]
...
```


For example, I want to see the format to install module "$ dnf module install NAME:STREAM/PROFILE",
and how to installed all the binary rpm in a module.
"$ dnf module install NAME:STREAM/all"?

Here is the dnf module's document. But it's limited document.
https://docs.fedoraproject.org/en-US/modularity/using-modules/

I want more detailed document, seeing an actual output of commands.

Is there this kind of "dnf module <command>" level document with actual output of the command?
This document?
https://dnf.readthedocs.io/en/latest/index.html

Version-Release number of selected component (if applicable):
dnf-4.2.2-2.fc30.noarch

Additional info:

Comment 1 Jun Aruga 2019-07-17 10:37:45 UTC
Any update?
I think you can refer below document for "dnf module <command> --help".
https://dnf.readthedocs.io/en/latest/command_ref.html#module-command-label

Comment 2 Jaroslav Mracek 2019-12-17 13:15:11 UTC
The latests release provided improvement. Tested with dnf-4.2.17.

dnf module install --help
usage: dnf module [-c [config file]] [-q] [-v] [--version]
                  [--installroot [path]] [--nodocs] [--noplugins]
                  [--enableplugin [plugin]] [--disableplugin [plugin]]
                  [--releasever RELEASEVER] [--setopt SETOPTS] [--skip-broken]
                  [-h] [--allowerasing] [-b | --nobest] [-C] [-R [minutes]]
                  [-d [debug level]] [--debugsolver] [--showduplicates]
                  [-e ERRORLEVEL] [--obsoletes]
                  [--rpmverbosity [debug level name]] [-y] [--assumeno]
                  [--enablerepo [repo]] [--disablerepo [repo] | --repo [repo]]
                  [--enable | --disable] [-x [package]]
                  [--disableexcludes [repo]] [--repofrompath [repo,path]]
                  [--noautoremove] [--nogpgcheck] [--color COLOR] [--refresh]
                  [-4] [-6] [--destdir DESTDIR] [--downloadonly]
                  [--comment COMMENT] [--bugfix] [--enhancement]
                  [--newpackage] [--security] [--advisory ADVISORY]
                  [--bz BUGZILLA] [--cve CVES]
                  [--sec-severity {Critical,Important,Moderate,Low}]
                  [--forcearch ARCH] [--enabled] [--disabled] [--installed]
                  [--profile] [--available] [--all]
                  <modular command> [module-spec [module-spec ...]]

Interact with Modules.

General DNF options:
  -c [config file], --config [config file]
                        config file location
  -q, --quiet           quiet operation
  -v, --verbose         verbose operation
  --version             show DNF version and exit
  --installroot [path]  set install root
  --nodocs              do not install documentations
  --noplugins           disable all plugins
  --enableplugin [plugin]
                        enable plugins by name
  --disableplugin [plugin]
                        disable plugins by name
  --releasever RELEASEVER
                        override the value of $releasever in config and repo
                        files
  --setopt SETOPTS      set arbitrary config and repo options
  --skip-broken         resolve depsolve problems by skipping packages
  -h, --help, --help-cmd
                        show command help
  --allowerasing        allow erasing of installed packages to resolve
                        dependencies
  -b, --best            try the best available package versions in
                        transactions.
  --nobest              do not limit the transaction to the best candidate
  -C, --cacheonly       run entirely from system cache, don't update cache
  -R [minutes], --randomwait [minutes]
                        maximum command wait time
  -d [debug level], --debuglevel [debug level]
                        debugging output level
  --debugsolver         dumps detailed solving results into files
  --showduplicates      show duplicates, in repos, in list/search commands
  -e ERRORLEVEL, --errorlevel ERRORLEVEL
                        error output level
  --obsoletes           enables dnf's obsoletes processing logic for upgrade
                        or display capabilities that the package obsoletes for
                        info, list and repoquery
  --rpmverbosity [debug level name]
                        debugging output level for rpm
  -y, --assumeyes       automatically answer yes for all questions
  --assumeno            automatically answer no for all questions
  --enablerepo [repo]   Enable additional repositories. List option. Supports
                        globs, can be specified multiple times.
  --disablerepo [repo]  Disable repositories. List option. Supports globs, can
                        be specified multiple times.
  --repo [repo], --repoid [repo]
                        enable just specific repositories by an id or a glob,
                        can be specified multiple times
  --enable, --set-enabled
                        enable repos with config-manager command
                        (automatically saves)
  --disable, --set-disabled
                        disable repos with config-manager command
                        (automatically saves)
  -x [package], --exclude [package], --excludepkgs [package]
                        exclude packages by name or glob
  --disableexcludes [repo], --disableexcludepkgs [repo]
                        disable excludepkgs
  --repofrompath [repo,path]
                        label and path to an additional repository to use
                        (same path as in a baseurl), can be specified multiple
                        times.
  --noautoremove        disable removal of dependencies that are no longer
                        used
  --nogpgcheck          disable gpg signature checking (if RPM policy allows)
  --color COLOR         control whether color is used
  --refresh             set metadata as expired before running the command
  -4                    resolve to IPv4 addresses only
  -6                    resolve to IPv6 addresses only
  --destdir DESTDIR, --downloaddir DESTDIR
                        set directory to copy packages to
  --downloadonly        only download packages
  --comment COMMENT     add a comment to transaction
  --bugfix              Include bugfix relevant packages, in updates
  --enhancement         Include enhancement relevant packages, in updates
  --newpackage          Include newpackage relevant packages, in updates
  --security            Include security relevant packages, in updates
  --advisory ADVISORY, --advisories ADVISORY
                        Include packages needed to fix the given advisory, in
                        updates
  --bz BUGZILLA, --bzs BUGZILLA
                        Include packages needed to fix the given BZ, in
                        updates
  --cve CVES, --cves CVES
                        Include packages needed to fix the given CVE, in
                        updates
  --sec-severity {Critical,Important,Moderate,Low}, --secseverity {Critical,Important,Moderate,Low}
                        Include security relevant packages matching the
                        severity, in updates
  --forcearch ARCH      Force the use of an architecture

Module command-specific options:
  --enabled             show only enabled modules
  --disabled            show only disabled modules
  --installed           show only installed modules or packages
  --profile             show profile content
  --available           show only available packages
  --all                 remove all modular packages

  <modular command>     disable: disable a module with all its streams
                        enable: enable a module stream
                        info: print detailed information about a module
                        install: install a module profile including its packages
                        list: list all module streams, profiles and states
                        provides: list modular packages
                        remove: remove installed module profiles and their packages
                        repoquery: list packages belonging to a module
                        reset: reset a module
                        update: update packages associated with an active stream
  module-spec           Module specification


Note You need to log in before you can comment on or make changes to this bug.