From f3d6a2299b2c89b7b2b373ee38fe8339689225bd Mon Sep 17 00:00:00 2001 From: Jan Kolarik Date: Thu, 21 Mar 2024 15:09:00 +0000 Subject: [PATCH] doc: Sync documentation in help and man pages --- dnf5-plugins/builddep_plugin/builddep.cpp | 8 ++-- dnf5/commands/check-upgrade/check-upgrade.cpp | 6 +-- dnf5/commands/distro-sync/distro-sync.cpp | 2 +- dnf5/commands/downgrade/downgrade.cpp | 4 +- dnf5/commands/download/download.cpp | 6 +-- dnf5/commands/group/group_install.cpp | 2 +- dnf5/commands/group/group_upgrade.cpp | 1 + dnf5/commands/install/install.cpp | 15 +++---- dnf5/commands/offline/offline.cpp | 4 +- dnf5/commands/reinstall/reinstall.cpp | 4 +- dnf5/commands/repoquery/repoquery.cpp | 6 +-- .../system-upgrade/system-upgrade.cpp | 4 +- dnf5/commands/upgrade/upgrade.cpp | 8 ++-- dnf5/commands/versionlock/versionlock.cpp | 4 +- doc/commands/autoremove.8.rst | 7 +++ doc/commands/downgrade.8.rst | 9 ++++ doc/commands/download.8.rst | 11 ++--- doc/commands/group.8.rst | 45 ++++++++++++++----- doc/commands/install.8.rst | 15 +++++-- doc/commands/module.8.rst | 23 ++++++---- doc/commands/offline.8.rst | 20 ++++++--- doc/commands/reinstall.8.rst | 9 ++++ doc/commands/remove.8.rst | 3 ++ doc/commands/search.8.rst | 3 ++ doc/commands/upgrade.8.rst | 23 ++++++---- doc/commands/versionlock.8.rst | 6 +-- doc/dnf5_plugins/automatic.8.rst | 10 ++--- doc/dnf5_plugins/builddep.8.rst | 24 ++++++---- doc/dnf5_plugins/copr.8.rst | 18 ++++---- doc/dnf5_plugins/needs_restarting.8.rst | 2 +- doc/dnf5_plugins/repoclosure.8.rst | 19 ++++---- 31 files changed, 203 insertions(+), 118 deletions(-) diff --git a/dnf5-plugins/builddep_plugin/builddep.cpp b/dnf5-plugins/builddep_plugin/builddep.cpp index b75b009b6..1cb67c7c5 100644 --- a/dnf5-plugins/builddep_plugin/builddep.cpp +++ b/dnf5-plugins/builddep_plugin/builddep.cpp @@ -63,10 +63,6 @@ void BuildDepCommand::set_argument_parser() { }); cmd.register_positional_arg(specs); - allow_erasing = std::make_unique(*this); - auto skip_unavailable = std::make_unique(*this); - create_allow_downgrade_options(*this); - auto defs = parser.add_new_named_arg("rpm_macros"); defs->set_short_name('D'); defs->set_long_name("define"); @@ -88,6 +84,10 @@ void BuildDepCommand::set_argument_parser() { return true; }); cmd.register_named_arg(defs); + + allow_erasing = std::make_unique(*this); + auto skip_unavailable = std::make_unique(*this); + create_allow_downgrade_options(*this); } void BuildDepCommand::configure() { diff --git a/dnf5/commands/check-upgrade/check-upgrade.cpp b/dnf5/commands/check-upgrade/check-upgrade.cpp index fbfed7187..daf53bf62 100644 --- a/dnf5/commands/check-upgrade/check-upgrade.cpp +++ b/dnf5/commands/check-upgrade/check-upgrade.cpp @@ -68,13 +68,13 @@ void CheckUpgradeCommand::set_argument_parser() { cmd.register_positional_arg(keys); advisory_name = std::make_unique(*this); + advisory_severity = std::make_unique(*this); + advisory_bz = std::make_unique(*this); + advisory_cve = std::make_unique(*this); advisory_security = std::make_unique(*this); advisory_bugfix = std::make_unique(*this); advisory_enhancement = std::make_unique(*this); advisory_newpackage = std::make_unique(*this); - advisory_severity = std::make_unique(*this); - advisory_bz = std::make_unique(*this); - advisory_cve = std::make_unique(*this); } void CheckUpgradeCommand::configure() { diff --git a/dnf5/commands/distro-sync/distro-sync.cpp b/dnf5/commands/distro-sync/distro-sync.cpp index 9c434bc31..dfabe69d4 100644 --- a/dnf5/commands/distro-sync/distro-sync.cpp +++ b/dnf5/commands/distro-sync/distro-sync.cpp @@ -50,8 +50,8 @@ void DistroSyncCommand::set_argument_parser() { cmd.register_positional_arg(patterns_arg); allow_erasing = std::make_unique(*this); - auto skip_unavailable = std::make_unique(*this); auto skip_broken = std::make_unique(*this); + auto skip_unavailable = std::make_unique(*this); create_offline_option(*this); } diff --git a/dnf5/commands/downgrade/downgrade.cpp b/dnf5/commands/downgrade/downgrade.cpp index 0b2c4c147..35ce090ae 100644 --- a/dnf5/commands/downgrade/downgrade.cpp +++ b/dnf5/commands/downgrade/downgrade.cpp @@ -52,10 +52,10 @@ void DowngradeCommand::set_argument_parser() { cmd.register_positional_arg(keys); allow_erasing = std::make_unique(*this); - create_downloadonly_option(*this); - auto skip_unavailable = std::make_unique(*this); auto skip_broken = std::make_unique(*this); + auto skip_unavailable = std::make_unique(*this); create_allow_downgrade_options(*this); + create_downloadonly_option(*this); create_offline_option(*this); } diff --git a/dnf5/commands/download/download.cpp b/dnf5/commands/download/download.cpp index 30241a24a..6a463e096 100644 --- a/dnf5/commands/download/download.cpp +++ b/dnf5/commands/download/download.cpp @@ -145,14 +145,14 @@ void DownloadCommand::set_argument_parser() { }); + cmd.register_named_arg(arch); + cmd.register_named_arg(resolve); cmd.register_named_arg(alldeps); create_destdir_option(*this); - cmd.register_named_arg(resolve); - cmd.register_positional_arg(keys); cmd.register_named_arg(srpm); cmd.register_named_arg(url); cmd.register_named_arg(urlprotocol); - cmd.register_named_arg(arch); + cmd.register_positional_arg(keys); } void DownloadCommand::configure() { diff --git a/dnf5/commands/group/group_install.cpp b/dnf5/commands/group/group_install.cpp index 3bca825ab..29a259321 100644 --- a/dnf5/commands/group/group_install.cpp +++ b/dnf5/commands/group/group_install.cpp @@ -40,8 +40,8 @@ void GroupInstallCommand::set_argument_parser() { group_specs = std::make_unique(*this, ArgumentParser::PositionalArg::AT_LEAST_ONE); allow_erasing = std::make_unique(*this); - auto skip_unavailable = std::make_unique(*this); auto skip_broken = std::make_unique(*this); + auto skip_unavailable = std::make_unique(*this); create_allow_downgrade_options(*this); create_downloadonly_option(*this); create_offline_option(*this); diff --git a/dnf5/commands/group/group_upgrade.cpp b/dnf5/commands/group/group_upgrade.cpp index 915d4a386..6c9f78f1d 100644 --- a/dnf5/commands/group/group_upgrade.cpp +++ b/dnf5/commands/group/group_upgrade.cpp @@ -40,6 +40,7 @@ void GroupUpgradeCommand::set_argument_parser() { allow_erasing = std::make_unique(*this); auto skip_unavailable = std::make_unique(*this); create_allow_downgrade_options(*this); + create_downloadonly_option(*this); create_offline_option(*this); } diff --git a/dnf5/commands/install/install.cpp b/dnf5/commands/install/install.cpp index fcff03838..b4f2c5d1e 100644 --- a/dnf5/commands/install/install.cpp +++ b/dnf5/commands/install/install.cpp @@ -53,21 +53,20 @@ void InstallCommand::set_argument_parser() { cmd.register_positional_arg(keys); allow_erasing = std::make_unique(*this); + auto skip_broken = std::make_unique(*this); + auto skip_unavailable = std::make_unique(*this); + create_allow_downgrade_options(*this); create_downloadonly_option(*this); + create_offline_option(*this); advisory_name = std::make_unique(*this); + advisory_severity = std::make_unique(*this); + advisory_bz = std::make_unique(*this); + advisory_cve = std::make_unique(*this); advisory_security = std::make_unique(*this); advisory_bugfix = std::make_unique(*this); advisory_enhancement = std::make_unique(*this); advisory_newpackage = std::make_unique(*this); - advisory_severity = std::make_unique(*this); - advisory_bz = std::make_unique(*this); - advisory_cve = std::make_unique(*this); - - auto skip_unavailable = std::make_unique(*this); - auto skip_broken = std::make_unique(*this); - create_allow_downgrade_options(*this); - create_offline_option(*this); } void InstallCommand::configure() { diff --git a/dnf5/commands/offline/offline.cpp b/dnf5/commands/offline/offline.cpp index 1559d4e05..2580216b3 100644 --- a/dnf5/commands/offline/offline.cpp +++ b/dnf5/commands/offline/offline.cpp @@ -189,10 +189,10 @@ void OfflineCommand::set_argument_parser() { void OfflineCommand::register_subcommands() { register_subcommand(std::make_unique(get_context())); - register_subcommand(std::make_unique(get_context())); - register_subcommand(std::make_unique(get_context())); register_subcommand(std::make_unique(get_context())); + register_subcommand(std::make_unique(get_context())); register_subcommand(std::make_unique(get_context())); + register_subcommand(std::make_unique(get_context())); } OfflineSubcommand::OfflineSubcommand(Context & context, const std::string & name) : Command(context, name) {} diff --git a/dnf5/commands/reinstall/reinstall.cpp b/dnf5/commands/reinstall/reinstall.cpp index 21b25e8c4..39e4d93d4 100644 --- a/dnf5/commands/reinstall/reinstall.cpp +++ b/dnf5/commands/reinstall/reinstall.cpp @@ -52,10 +52,10 @@ void ReinstallCommand::set_argument_parser() { cmd.register_positional_arg(keys); allow_erasing = std::make_unique(*this); - create_downloadonly_option(*this); - auto skip_unavailable = std::make_unique(*this); auto skip_broken = std::make_unique(*this); + auto skip_unavailable = std::make_unique(*this); create_allow_downgrade_options(*this); + create_downloadonly_option(*this); create_offline_option(*this); } diff --git a/dnf5/commands/repoquery/repoquery.cpp b/dnf5/commands/repoquery/repoquery.cpp index e51159c18..0ae567f4b 100644 --- a/dnf5/commands/repoquery/repoquery.cpp +++ b/dnf5/commands/repoquery/repoquery.cpp @@ -193,13 +193,13 @@ void RepoqueryCommand::set_argument_parser() { // SIMPLE FILTERS: advisory_name = std::make_unique(*this); + advisory_severity = std::make_unique(*this); + advisory_bz = std::make_unique(*this); + advisory_cve = std::make_unique(*this); advisory_security = std::make_unique(*this); advisory_bugfix = std::make_unique(*this); advisory_enhancement = std::make_unique(*this); advisory_newpackage = std::make_unique(*this); - advisory_severity = std::make_unique(*this); - advisory_bz = std::make_unique(*this); - advisory_cve = std::make_unique(*this); latest_limit_option = dynamic_cast *>( parser.add_init_value(std::make_unique>(0))); diff --git a/dnf5/commands/system-upgrade/system-upgrade.cpp b/dnf5/commands/system-upgrade/system-upgrade.cpp index cd9512931..113681d0d 100644 --- a/dnf5/commands/system-upgrade/system-upgrade.cpp +++ b/dnf5/commands/system-upgrade/system-upgrade.cpp @@ -55,10 +55,10 @@ void SystemUpgradeCommand::set_argument_parser() { } void SystemUpgradeCommand::register_subcommands() { - register_subcommand(std::make_unique(get_context())); register_subcommand(std::make_unique(get_context())); - register_subcommand(std::make_unique(get_context())); + register_subcommand(std::make_unique(get_context())); register_subcommand(std::make_unique(get_context())); + register_subcommand(std::make_unique(get_context())); } void SystemUpgradeDownloadCommand::set_argument_parser() { diff --git a/dnf5/commands/upgrade/upgrade.cpp b/dnf5/commands/upgrade/upgrade.cpp index 89bf7db1f..862532dfc 100644 --- a/dnf5/commands/upgrade/upgrade.cpp +++ b/dnf5/commands/upgrade/upgrade.cpp @@ -66,20 +66,20 @@ void UpgradeCommand::set_argument_parser() { allow_erasing = std::make_unique(*this); auto skip_unavailable = std::make_unique(*this); create_allow_downgrade_options(*this); - create_downloadonly_option(*this); create_destdir_option(*this); + create_downloadonly_option(*this); auto & destdir = parser.get_named_arg("upgrade.destdir", false); destdir.set_description(destdir.get_description() + " Automatically sets the --downloadonly option."); create_offline_option(*this); advisory_name = std::make_unique(*this); + advisory_severity = std::make_unique(*this); + advisory_bz = std::make_unique(*this); + advisory_cve = std::make_unique(*this); advisory_security = std::make_unique(*this); advisory_bugfix = std::make_unique(*this); advisory_enhancement = std::make_unique(*this); advisory_newpackage = std::make_unique(*this); - advisory_severity = std::make_unique(*this); - advisory_bz = std::make_unique(*this); - advisory_cve = std::make_unique(*this); } void UpgradeCommand::configure() { diff --git a/dnf5/commands/versionlock/versionlock.cpp b/dnf5/commands/versionlock/versionlock.cpp index 1d0bb0fcc..bcf54f081 100644 --- a/dnf5/commands/versionlock/versionlock.cpp +++ b/dnf5/commands/versionlock/versionlock.cpp @@ -42,11 +42,11 @@ void VersionlockCommand::register_subcommands() { auto * commands_group = get_context().get_argument_parser().add_new_group("versionlock_commands"); commands_group->set_header("Versionlock Commands:"); get_argument_parser_command()->register_group(commands_group); - register_subcommand(std::make_unique(get_context()), commands_group); register_subcommand(std::make_unique(get_context()), commands_group); register_subcommand(std::make_unique(get_context()), commands_group); - register_subcommand(std::make_unique(get_context()), commands_group); register_subcommand(std::make_unique(get_context()), commands_group); + register_subcommand(std::make_unique(get_context()), commands_group); + register_subcommand(std::make_unique(get_context()), commands_group); } void VersionlockCommand::pre_configure() { diff --git a/doc/commands/autoremove.8.rst b/doc/commands/autoremove.8.rst index 8f8909700..783b9f3c4 100644 --- a/doc/commands/autoremove.8.rst +++ b/doc/commands/autoremove.8.rst @@ -40,3 +40,10 @@ any such package. Installonly packages (e.g. kernels) are never automatically removed by this command even if they were installed as dependencies. + + +Options +======= + +``--offline`` + | Store the transaction to be performed offline. See :manpage:`dnf5-offline(8)`, :ref:`Offline command `. diff --git a/doc/commands/downgrade.8.rst b/doc/commands/downgrade.8.rst index 522bbae56..796bb55cb 100644 --- a/doc/commands/downgrade.8.rst +++ b/doc/commands/downgrade.8.rst @@ -48,6 +48,15 @@ Options ``--skip-unavailable`` | Allow skipping packages that are not possible to downgrade. All remaining packages will be downgraded. +``--allow-downgrade`` + | Enable downgrade of dependencies when resolving the requested operation. + +``--no-allow-downgrade`` + | Disable downgrade of dependencies when resolving the requested operation. + +``--downloadonly`` + | Download the resolved package set without executing an RPM transaction. + ``--offline`` | Store the transaction to be performed offline. See :manpage:`dnf5-offline(8)`, :ref:`Offline command `. diff --git a/doc/commands/download.8.rst b/doc/commands/download.8.rst index dce4ebf0f..fdec0e816 100644 --- a/doc/commands/download.8.rst +++ b/doc/commands/download.8.rst @@ -38,6 +38,9 @@ defined in ``package-spec`` arguments to the current working directory. Options ======= +``--arch`` + | Limit to packages of given architectures. This option can be used multiple times. + ``--resolve`` | Resolve dependencies of specified packages and download missing ones. @@ -47,17 +50,15 @@ Options ``--destdir=`` | Set directory used for downloading packages to. Default location is to the current working directory. +``--srpm`` + | Download the source rpm. Enables source repositories of all enabled binary repositories. + ``--url`` | Prints the list of URLs where the rpms can be downloaded instead of downloading. ``--urlprotocol`` | To be used together with ``--url``. It filters out the URLs to the specified protocols: ``http``, ``https``, ``ftp``, or ``file``. This option can be used multiple times. -``--arch`` - | Limit to packages of given architectures. This option can be used multiple times. - -``--srpm`` - | Download the source rpm. Enables source repositories of all enabled binary repositories. Examples ======== diff --git a/doc/commands/group.8.rst b/doc/commands/group.8.rst index 03ddb896c..7948a674d 100644 --- a/doc/commands/group.8.rst +++ b/doc/commands/group.8.rst @@ -81,8 +81,9 @@ Subcommands a different reason (e.g. explicitly installed by a user or implicitly installed as a dependency). -Options -======= + +Options for ``list`` and ``info`` +================================= ``--available`` | Show only available groups. Those which are not installed, but known to ``DNF5``. @@ -93,27 +94,47 @@ Options ``--hidden`` | Show also hidden groups. +``--contains-pkgs`` + | Show only groups containing packages with specified names. List option, supports globs. + + +Options for ``install``, ``remove`` and ``upgrade`` +=================================================== + ``--with-optional`` - | Used with ``install`` command to include optional packages from the groups. + | Include optional packages from the groups. + | Used with ``install`` command. ``--no-packages`` - | Used with ``install`` and ``remove`` commands to operate exclusively on the groups without manipulating any packages. - -``--contains-pkgs`` - | Show only groups containing packages with specified names. List option, supports globs. + | Operate exclusively on the groups without manipulating any packages. + | Used with ``install`` and ``remove`` commands. ``--allowerasing`` - | Used with ``install`` and ``upgrade`` to allow erasing of installed packages to resolve any potential dependency problems. + | Allow erasing of installed packages to resolve any potential dependency problems. + | Used with ``install`` and ``upgrade`` commands. ``--skip-broken`` - | Used with ``install`` command to resolve any dependency problems by removing packages that are causing problems from the transaction. + | Resolve any dependency problems by removing packages that are causing problems from the transaction. + | Used with ``install`` command. ``--skip-unavailable`` - | Used with ``install`` and ``upgrade`` to allow skipping packages that are not possible to install or upgrade. - | All remaining packages will be installed or upgraded. + | Allow skipping packages that are not possible to install or upgrade. + | Used with ``install`` and ``upgrade`` commands. + +``--allow-downgrade`` + | Enable downgrade of dependencies when resolving the requested operation. + | Used with ``install`` and ``upgrade`` commands. + +``--no-allow-downgrade`` + | Disable downgrade of dependencies when resolving the requested operation. + | Used with ``install`` and ``upgrade`` commands. + +``--downloadonly`` + | Download the resolved package set without executing an RPM transaction. + | Used with ``install`` and ``upgrade`` commands. ``--offline`` - | Used with ``install``, ``remove``, and ``upgrade``. Store the transaction to be performed offline. See :manpage:`dnf5-offline(8)`, :ref:`Offline command `. + | Store the transaction to be performed offline. See :manpage:`dnf5-offline(8)`, :ref:`Offline command `. Examples diff --git a/doc/commands/install.8.rst b/doc/commands/install.8.rst index 27f9d33e5..24bafe3e1 100644 --- a/doc/commands/install.8.rst +++ b/doc/commands/install.8.rst @@ -48,6 +48,18 @@ Options ``--skip-unavailable`` | Allow skipping packages that are not available in repositories. All available packages will be installed. +``--allow-downgrade`` + | Enable downgrade of dependencies when resolving the requested operation. + +``--no-allow-downgrade`` + | Disable downgrade of dependencies when resolving the requested operation. + +``--downloadonly`` + | Download the resolved package set without executing an RPM transaction. + +``--offline`` + | Store the transaction to be performed offline. See :manpage:`dnf5-offline(8)`, :ref:`Offline command `. + ``--advisories=ADVISORY_NAME,...`` | Consider only content contained in advisories with specified name. | This is a list option. @@ -80,9 +92,6 @@ Options ``--newpackage`` | Consider only content contained in newpackage advisories. -``--offline`` - | Store the transaction to be performed offline. See :manpage:`dnf5-offline(8)`, :ref:`Offline command `. - Examples ======== diff --git a/doc/commands/module.8.rst b/doc/commands/module.8.rst index fda8c3d7b..99cd2298d 100644 --- a/doc/commands/module.8.rst +++ b/doc/commands/module.8.rst @@ -58,15 +58,8 @@ Subcommands | Reset module state so it's no longer enabled or disabled. -Options -======= - -``--skip-broken`` - | Used with ``enable`` command to resolve any dependency problems by removing items that are causing problems from the transaction. - -``--skip-unavailable`` - | Used with ``enable``, ``disable`` and ``reset`` commands to allow skipping modules that are not available in repositories. - | All remaining items will be processed. +Options for ``list`` and ``info`` +================================= ``--enabled`` | Show only enabled modules. @@ -75,6 +68,18 @@ Options | Show only disabled modules. +Options for ``enable``, ``disable``, ``reset`` +============================================== + +``--skip-broken`` + | Resolve any dependency problems by removing items that are causing problems from the transaction. + | Used with ``enable`` command. + +``--skip-unavailable`` + | Allow skipping modules that are not available in repositories. + | All remaining items will be processed. + + Examples ======== diff --git a/doc/commands/offline.8.rst b/doc/commands/offline.8.rst index 2352c257c..0e59746b2 100644 --- a/doc/commands/offline.8.rst +++ b/doc/commands/offline.8.rst @@ -42,26 +42,34 @@ Subcommands =========== ``clean`` - Removes any stored offline transaction and deletes cached package files. + | Removes any stored offline transaction and deletes cached package files. ``log`` - Used to see a list of boots during which an offline transaction was attempted, or show the logs from an attempted offline transaction. The logs for one of the boots can be shown by specifying one of the numbers in the first column with the ``--number`` argument. Negative numbers can be used to number the boots from last to first. For example, ``log --number=-1`` can be used to see the logs for the last offline transaction. + | Used to see a list of boots during which an offline transaction was attempted, or show the logs from an attempted offline transaction. The logs for one of the boots can be shown by specifying one of the numbers in the first column with the ``--number`` argument. Negative numbers can be used to number the boots from last to first. For example, ``log --number=-1`` can be used to see the logs for the last offline transaction. ``reboot`` - Prepares the system to perform the offline transaction and reboots to start the transaction. This command can only be run after an offline transaction is initiated (e.g. by ``dnf5 system-upgrade download``). + | Prepares the system to perform the offline transaction and reboots to start the transaction. This command can only be run after an offline transaction is initiated (e.g. by ``dnf5 system-upgrade download``). ``status`` - Shows the status of the current offline transaction. + | Shows the status of the current offline transaction. + +``_execute`` + | Execute the transaction in the offline environment. + + .. warning:: + For internal use only. Not intended to be run by the user. Options ======= ``--number=`` - Used with the ``log`` subcommand. Show the log specified by the number. Run ``dnf5 offline log`` with ``--number`` first to get a list of logs to choose from. + | Show the log specified by the number. Run ``dnf5 offline log`` with ``--number`` first to get a list of logs to choose from. + | Used with the ``log`` subcommand. ``--poweroff`` - Used with the ``reboot`` subcommand. The system will power off after the transaction is completed instead of restarting. If the transaction failed, the system will reboot instead of powering off even with this flag. + | The system will power off after the transaction is completed instead of restarting. If the transaction failed, the system will reboot instead of powering off even with this flag. + | Used with the ``reboot`` subcommand. Examples diff --git a/doc/commands/reinstall.8.rst b/doc/commands/reinstall.8.rst index 11aacc6dd..3b4f9d5d2 100644 --- a/doc/commands/reinstall.8.rst +++ b/doc/commands/reinstall.8.rst @@ -47,6 +47,15 @@ Options ``--skip-unavailable`` | Allow skipping packages that are not possible to reinstall. All remaining packages will be reinstalled. +``--allow-downgrade`` + | Enable downgrade of dependencies when resolving the requested operation. + +``--no-allow-downgrade`` + | Disable downgrade of dependencies when resolving the requested operation. + +``--downloadonly`` + | Download the resolved package set without executing an RPM transaction. + ``--offline`` | Store the transaction to be performed offline. See :manpage:`dnf5-offline(8)`, :ref:`Offline command `. diff --git a/doc/commands/remove.8.rst b/doc/commands/remove.8.rst index 53a149a4f..0eeec76a0 100644 --- a/doc/commands/remove.8.rst +++ b/doc/commands/remove.8.rst @@ -41,6 +41,9 @@ set the ``clean_requirements_on_remove`` configuration option to ``False``. Options ======= +``--no-autoremove`` + | Disable removal of dependencies that are no longer used. + ``--offline`` | Store the transaction to be performed offline. See :manpage:`dnf5-offline(8)`, :ref:`Offline command `. diff --git a/doc/commands/search.8.rst b/doc/commands/search.8.rst index 0938ac422..e1a4be2c1 100644 --- a/doc/commands/search.8.rst +++ b/doc/commands/search.8.rst @@ -46,6 +46,9 @@ Options | Search patterns also inside `Description` and `URL` fields. | By applying this option the search lists packages that match at least one of the keys (OR operation). +``--showduplicates`` + | Show all versions of packages, not only the latest ones. + Examples ======== diff --git a/doc/commands/upgrade.8.rst b/doc/commands/upgrade.8.rst index 6580bdb6e..900ed2789 100644 --- a/doc/commands/upgrade.8.rst +++ b/doc/commands/upgrade.8.rst @@ -39,21 +39,29 @@ Options ======= ``--minimal`` - Update packages only to the lowest higher available version that provides a bugfix, - enhancement or a fix for a security issue. + | Update packages only to the lowest available version that provides bug fixes, enhancements, or security fixes. ``--allowerasing`` | Allow erasing of installed packages to resolve any potential dependency problems. -``--downloadonly`` - | Only download packages for transaction. +``--skip-unavailable`` + | Allow skipping packages that are not possible to upgrade. All remaining packages will be upgraded. + +``--allow-downgrade`` + | Enable downgrade of dependencies when resolving the requested operation. + +``--no-allow-downgrade`` + | Disable downgrade of dependencies when resolving the requested operation. ``--destdir=`` | Set directory used for downloading packages to. Default location is to the current working directory. | Automatically sets the ``downloadonly`` option. -``--skip-unavailable`` - | Allow skipping packages that are not possible to upgrade. All remaining packages will be upgraded. +``--downloadonly`` + | Only download packages for transaction. + +``--offline`` + | Store the transaction to be performed offline. See :manpage:`dnf5-offline(8)`, :ref:`Offline command `. ``--advisories=ADVISORY_NAME,...`` | Consider only content contained in advisories with specified name. @@ -87,9 +95,6 @@ Options ``--newpackage`` | Consider only content contained in newpackage advisories. -``--offline`` - | Store the transaction to be performed offline. See :manpage:`dnf5-offline(8)`, :ref:`Offline command `. - Examples ======== diff --git a/doc/commands/versionlock.8.rst b/doc/commands/versionlock.8.rst index 753165124..9e31b0d9b 100644 --- a/doc/commands/versionlock.8.rst +++ b/doc/commands/versionlock.8.rst @@ -57,15 +57,15 @@ Subcommands ``exclude`` | Add an exclude (within versionlock) for the available packages matching the spec. It means that packages represented by ``package-spec`` will be excluded from transaction operations. +``clear`` + | Remove all versionlock entries. + ``delete`` | Remove any matching versionlock entries. ``list`` | List the current versionlock entries. -``clear`` - | Remove all versionlock entries. - Examples ======== diff --git a/doc/dnf5_plugins/automatic.8.rst b/doc/dnf5_plugins/automatic.8.rst index 22ffc27ea..53f7958d9 100644 --- a/doc/dnf5_plugins/automatic.8.rst +++ b/doc/dnf5_plugins/automatic.8.rst @@ -50,19 +50,19 @@ Options ======= ``--timer`` - Apply random delay before execution. + | Apply random delay before execution. ``--downloadupdates`` - Automatically download updated packages. + | Automatically download updated packages. ``--no-downloadupdates`` - Do not automatically download updated packages. + | Do not automatically download updated packages. ``--installupdates`` - Automatically install downloaded updates (implies --downloadupdates). + | Automatically install downloaded updates (implies --downloadupdates). ``--no-installupdates`` - Do not automatically install downloaded updates. + | Do not automatically install downloaded updates. Run dnf-automatic diff --git a/doc/dnf5_plugins/builddep.8.rst b/doc/dnf5_plugins/builddep.8.rst index 1a0eb107c..977dfbc26 100644 --- a/doc/dnf5_plugins/builddep.8.rst +++ b/doc/dnf5_plugins/builddep.8.rst @@ -41,34 +41,40 @@ Install missing dependencies for building an RPM package. Options ======= +``-D "macro expr", --define="macro expr"`` + | Define a rpm macro. Set the value "expr" to the macro "macro" when parsing spec files. Does not apply for source rpm files. + ``--allowerasing`` - Allow erasing of installed packages to resolve dependencies resolution problems. + | Allow erasing of installed packages to resolve any potential dependency problems. ``--skip-unavailable`` - Allow skipping build dependencies not available in repositories. All available build dependencies will be installed. + | Allow skipping packages that are not possible to downgrade. All remaining packages will be downgraded. -``-D "macro expr", --define="macro expr"`` - Define a rpm macro. Set the value "expr" to the macro "macro" when parsing spec files. Does not apply for source rpm files. +``--allow-downgrade`` + | Enable downgrade of dependencies when resolving the requested operation. + +``--no-allow-downgrade`` + | Disable downgrade of dependencies when resolving the requested operation. Arguments ========= ```` - Either path to .src.rpm, .nosrc.rpm or .spec file or package available in a repository. + | Either path to .src.rpm, .nosrc.rpm or .spec file or package available in a repository. Examples ======== ``dnf builddep foobar.spec`` - Install the needed build requirements, defined in the foobar.spec file. + | Install the needed build requirements, defined in the foobar.spec file. ``dnf builddep foobar-1.0-1.src.rpm`` - Install the needed build requirements, defined in the foobar-1.0-1.src.rpm file. + | Install the needed build requirements, defined in the foobar-1.0-1.src.rpm file. ``dnf builddep foobar-1.0-1`` - Look up foobar-1.0-1 in enabled repositories and install build requirements for its source rpm. + | Look up foobar-1.0-1 in enabled repositories and install build requirements for its source rpm. ``dnf builddep -D 'scl python27' python-foobar.spec`` - Install the needed build requirements for the python27 SCL version of python-foobar. + | Install the needed build requirements for the python27 SCL version of python-foobar. diff --git a/doc/dnf5_plugins/copr.8.rst b/doc/dnf5_plugins/copr.8.rst index 9096e560e..3ec0dfe23 100644 --- a/doc/dnf5_plugins/copr.8.rst +++ b/doc/dnf5_plugins/copr.8.rst @@ -38,26 +38,26 @@ Subcommands =========== ``list`` - List Copr repositories. + | List Copr repositories. ``enable []`` - Download the repository info from a Copr server and install it as a `/etc/yum.repos.d/*.repo` file. + | Download the repository info from a Copr server and install it as a `/etc/yum.repos.d/*.repo` file. ``disable `` - Disable specified Copr repository (if exists), keep `/etc/yum.repos.d/*.repo` file - just set enabled=0. + | Disable specified Copr repository (if exists), keep `/etc/yum.repos.d/*.repo` file - just set enabled=0. ``remove `` - Remove specified Copr repository from the system. Also removes the `/etc/yum.repos.d/*.repo` file. + | Remove specified Copr repository from the system. Also removes the `/etc/yum.repos.d/*.repo` file. ``debug`` - Print info about the system useful for debugging. + | Print info about the system useful for debugging. Options ======= ``--hub`` - Copr hub (the web-UI/API server) hostname. Defaults to `copr.fedorainfracloud.org`. + | Copr hub (the web-UI/API server) hostname. Defaults to `copr.fedorainfracloud.org`. Arguments @@ -87,10 +87,10 @@ Examples ======== ``dnf5 copr enable rhscl/perl516 epel-6-x86_64`` - Enable the rhscl/perl516 Copr repository, using the epel-6-x86_64 chroot. + | Enable the rhscl/perl516 Copr repository, using the epel-6-x86_64 chroot. ``dnf5 copr disable rhscl/perl516`` - Disable the rhscl/perl516 Copr repository + | Disable the rhscl/perl516 Copr repository ``dnf5 copr list`` - List Copr repositories configured on the system. + | List Copr repositories configured on the system. diff --git a/doc/dnf5_plugins/needs_restarting.8.rst b/doc/dnf5_plugins/needs_restarting.8.rst index 387f21ad7..658c40417 100644 --- a/doc/dnf5_plugins/needs_restarting.8.rst +++ b/doc/dnf5_plugins/needs_restarting.8.rst @@ -40,4 +40,4 @@ Options ======= ``-s, --services`` - List systemd services that need restarting. If the package that provides the service, or any of its dependencies, have been updated since the service started, then restarting the service will be recommended. Note that this approach is quite aggressive to recommend a restart when one may not be strictly necessary. + | List systemd services that need restarting. If the package that provides the service, or any of its dependencies, have been updated since the service started, then restarting the service will be recommended. Note that this approach is quite aggressive to recommend a restart when one may not be strictly necessary. diff --git a/doc/dnf5_plugins/repoclosure.8.rst b/doc/dnf5_plugins/repoclosure.8.rst index 1244e292a..bbba6419d 100644 --- a/doc/dnf5_plugins/repoclosure.8.rst +++ b/doc/dnf5_plugins/repoclosure.8.rst @@ -40,33 +40,32 @@ Options ======= ``--arch `` - Query only packages for specified architecture, can be specified multiple times (default is all - compatible architectures with your system). + | Query only packages for specified architecture, can be specified multiple times (default is all compatible architectures with your system). ``--best`` - Check only the newest packages per arch. + | Check only the newest packages per arch. ``--check `` - Specify repositories to check, can be specified multiple times (default is all enabled repositories). + | Specify repositories to check, can be specified multiple times (default is all enabled repositories). ``--newest`` - Check only the newest packages in the repos. + | Check only the newest packages in the repos. ```` - Check closure for this package only. + | Check closure for this package only. Examples ======== ``dnf5 repoclosure`` - Display a list of unresolved dependencies for all enabled repositories. + | Display a list of unresolved dependencies for all enabled repositories. ``dnf5 repoclosure --repo rawhide --arch noarch --arch x86_64`` - Display a list of unresolved dependencies for rawhide repository and packages with architecture noarch and x86_64. + | Display a list of unresolved dependencies for rawhide repository and packages with architecture noarch and x86_64. ``dnf5 repoclosure --repo rawhide zmap`` - Display a list of unresolved dependencies for zmap package from rawhide repository. + | Display a list of unresolved dependencies for zmap package from rawhide repository. ``dnf5 repoclosure --repo rawhide --check myrepo`` - Display a list of unresolved dependencies for myrepo, an add-on for the rawhide repository. + | Display a list of unresolved dependencies for myrepo, an add-on for the rawhide repository.