Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: minor formatting and consistency fixes #2103

Merged
merged 1 commit into from
Jul 2, 2024
Merged

doc: minor formatting and consistency fixes #2103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If you want to build the manpages, use the option ``-DWITH_MAN=0`` with cmake.

Man pages will be located in ``build/doc`` and can be read with ``man -l``, e.g::

man -l build/doc/dnf.8
man -l build/doc/dnf4.8

=============================
Building and installing rpm
Expand Down
99 changes: 43 additions & 56 deletions doc/command_ref.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,6 @@ Options
.. _disableexcludes-label:

``--disableexcludes=[all|main|<repoid>], --disableexcludepkgs=[all|main|<repoid>]``

Disable the configuration file excludes. Takes one of the following three options:

* ``all``, disables all configuration file excludes
Expand Down Expand Up @@ -509,9 +508,9 @@ Autoremove Command
package directly, or a ``@<group-spec>``, which specifies an (environment) group which contains
it. It also removes any dependencies that are no longer needed.

There are also a few specific autoremove commands ``autoremove-n``, ``autoremove-na`` and
``autoremove-nevra`` that allow the specification of an exact argument in the NEVRA
(name-epoch:version-release.architecture) format.
There are also a few specific autoremove commands ``autoremove-n``, ``autoremove-na`` and
``autoremove-nevra`` that allow the specification of an exact argument in the NEVRA
(name-epoch:version-release.architecture) format.

This command by default does not force a sync of expired metadata. See also :ref:`\metadata_synchronization-label`.

Expand Down Expand Up @@ -541,7 +540,6 @@ Check-Update Command


``dnf [options] check-update [--changelogs] [<package-file-spec>...]``

Non-interactively checks if updates of the specified packages are available. If no ``<package-file-spec>`` is given, checks whether any updates at all are available for your system. DNF exit code will be 100 when there are updates available and a list of the updates will be printed, 0 if not and 1 if an error occurs. If ``--changelogs`` option is specified, also changelog delta of packages about to be updated is printed.

Please note that having a specific newer version available for an installed package (and reported by ``check-update``) does not imply that subsequent ``dnf upgrade`` will install it. The difference is that ``dnf upgrade`` has restrictions (like package dependencies being satisfied) to take into account.
Expand Down Expand Up @@ -856,11 +854,11 @@ Install Command
some older version is being obsoleted. It creates a split in the upgrade-path and both ways
are considered correct, the resulting package is picked simply by lexicographical order.

There are also a few specific install commands ``install-n``, ``install-na`` and
``install-nevra`` that allow the specification of an exact argument in the NEVRA format. As a consequence, <spec>
will be not matched with provides and file provides.
There are also a few specific install commands ``install-n``, ``install-na`` and
``install-nevra`` that allow the specification of an exact argument in the NEVRA format. As a consequence, <spec>
will be not matched with provides and file provides.

See also :ref:`\configuration_files_replacement_policy-label`.
See also :ref:`\configuration_files_replacement_policy-label`.

.. _install_examples-label:

Expand Down Expand Up @@ -1152,7 +1150,7 @@ Provides Command

4. If this last step also fails, DNF returns "Error: No Matches found".

This command by default does not force a sync of expired metadata. See also :ref:`\metadata_synchronization-label`.
This command by default does not force a sync of expired metadata. See also :ref:`\metadata_synchronization-label`.

.. _reinstall_command-label:

Expand Down Expand Up @@ -1191,9 +1189,9 @@ Remove Command
``dnf [options] remove --oldinstallonly``
Removes old installonly packages, keeping only latest versions and version of running kernel.

There are also a few specific remove commands ``remove-n``, ``remove-na`` and ``remove-nevra``
that allow the specification of an exact argument in the NEVRA format. As a consequence, <spec>
will be not matched with provides and file provides.
There are also a few specific remove commands ``remove-n``, ``remove-na`` and ``remove-nevra``
that allow the specification of an exact argument in the NEVRA format. As a consequence, <spec>
will be not matched with provides and file provides.

Remove Examples
---------------
Expand All @@ -1205,9 +1203,9 @@ Remove Examples
Remove packages not present in any repository, but don't remove the ``tito``
and ``acpi`` packages (they still might be removed if they depend on some of the removed packages).

Remove older versions of duplicated packages (an equivalent of yum's `package-cleanup --cleandups`)::
``dnf remove --duplicates``
Remove older versions of duplicated packages (an equivalent of yum's `package-cleanup --cleandups`).

dnf remove --duplicates

.. _repoinfo_command-label:

Expand All @@ -1217,8 +1215,8 @@ Repoinfo Command

| Command: ``repoinfo``

An alias for the :ref:`repolist <repolist_command-label>` command
that provides more detailed information like ``dnf repolist -v``.
An alias for the :ref:`repolist <repolist_command-label>` command
that provides more detailed information like ``dnf repolist -v``.

.. _repolist_command-label:

Expand Down Expand Up @@ -1255,9 +1253,9 @@ Repoquery Command
``dnf [options] repoquery --querytags``
Provides the list of tags recognized by the \-\ :ref:`-queryformat <queryformat_repoquery-label>` repoquery option.

There are also a few specific repoquery commands ``repoquery-n``, ``repoquery-na`` and ``repoquery-nevra``
that allow the specification of an exact argument in the NEVRA format (does not affect arguments of options like --whatprovides <arg>, ...).
As a consequence, <spec> will be not matched with file provides.
There are also a few specific repoquery commands ``repoquery-n``, ``repoquery-na`` and ``repoquery-nevra``
that allow the specification of an exact argument in the NEVRA format (does not affect arguments of options like --whatprovides <arg>, ...).
As a consequence, <spec> will be not matched with file provides.

Select Options
--------------
Expand Down Expand Up @@ -1476,52 +1474,41 @@ are displayed in the standard NEVRA notation.
resolve capabilities to originating package(s).


Examples
--------

Display NEVRAs of all available packages matching ``light*``::

dnf repoquery 'light*'

Display NEVRAs of all available packages matching name ``light*`` and architecture ``noarch`` (accepts only arguments in the "<name>.<arch>" format)::

dnf repoquery-na 'light*.noarch'

Display requires of all lighttpd packages::

dnf repoquery --requires lighttpd

Display packages providing the requires of python packages::

dnf repoquery --requires python --resolve

Display source rpm of ligttpd package::

dnf repoquery --source lighttpd

Display package name that owns the given file::
Repoquery Examples
------------------

dnf repoquery --file /etc/lighttpd/lighttpd.conf
``dnf repoquery 'light*'``
Display NEVRAs of all available packages matching ``light*``

Display name, architecture and the containing repository of all lighttpd packages::
``dnf repoquery-na 'light*.noarch'``
Display NEVRAs of all available packages matching name ``light*`` and architecture ``noarch`` (accepts only arguments in the "<name>.<arch>" format)

dnf repoquery --queryformat '%{name}.%{arch} : %{reponame}' lighttpd
``dnf repoquery --requires lighttpd``
Display requires of all lighttpd packages

Display all available packages providing "webserver"::
``dnf repoquery --requires python --resolve``
Display packages providing the requires of python packages

dnf repoquery --whatprovides webserver
``dnf repoquery --source lighttpd``
Display source rpm of lighttpd package

Display all available packages providing "webserver" but only for "i686" architecture::
``dnf repoquery --file /etc/lighttpd/lighttpd.conf``
Display package name that owns the given file

dnf repoquery --whatprovides webserver --arch i686
``dnf repoquery --queryformat '%{name}.%{arch} : %{reponame}' lighttpd``
Display name, architecture and the containing repository of all lighttpd packages

Display duplicate packages::
``dnf repoquery --whatprovides webserver``
Display all available packages providing "webserver"

dnf repoquery --duplicates
``dnf repoquery --whatprovides webserver --arch i686``
Display all available packages providing "webserver" but only for "i686" architecture

Display source packages that require a <provide> for a build::
``dnf repoquery --duplicates``
Display duplicate packages

dnf repoquery --disablerepo="*" --enablerepo="*-source" --arch=src --whatrequires <provide>
``dnf repoquery --disablerepo="*" --enablerepo="*-source" --arch=src --whatrequires <provide>``
Display source packages that require a <provide> for a build

.. _repository_packages_command-label:

Expand Down Expand Up @@ -1669,7 +1656,7 @@ Swap Command

``dnf [options] swap <remove-spec> <install-spec>``

Remove spec and install spec in one transaction. Each ``<spec>`` can be either a
Remove ``remove-spec`` and install ``install-spec`` in one transaction. Each ``<spec>`` can be either a
:ref:`<package-spec> <specifying_packages-label>`, which specifies a package directly, or a
``@<group-spec>``, which specifies an (environment) group which contains it. Automatic
conflict solving is provided in DNF by the --allowerasing option that provides the functionality of the swap
Expand Down
Loading