Blame doc/groups-manager.rst

Packit Service 54d9af
..
Packit Service 54d9af
  Copyright (C) 2020  Red Hat, Inc.
Packit Service 54d9af
Packit Service 54d9af
  This copyrighted material is made available to anyone wishing to use,
Packit Service 54d9af
  modify, copy, or redistribute it subject to the terms and conditions of
Packit Service 54d9af
  the GNU General Public License v.2, or (at your option) any later version.
Packit Service 54d9af
  This program is distributed in the hope that it will be useful, but WITHOUT
Packit Service 54d9af
  ANY WARRANTY expressed or implied, including the implied warranties of
Packit Service 54d9af
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
Packit Service 54d9af
  Public License for more details.  You should have received a copy of the
Packit Service 54d9af
  GNU General Public License along with this program; if not, write to the
Packit Service 54d9af
  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
Packit Service 54d9af
  02110-1301, USA.  Any Red Hat trademarks that are incorporated in the
Packit Service 54d9af
  source code or documentation are not subject to the GNU General Public
Packit Service 54d9af
  License and may only be used or replicated with the express permission of
Packit Service 54d9af
  Red Hat, Inc.
Packit Service 54d9af
Packit Service 54d9af
=========================
Packit Service 54d9af
DNF groups-manager Plugin
Packit Service 54d9af
=========================
Packit Service 54d9af
Packit Service 54d9af
Create and edit groups repository metadata files.
Packit Service 54d9af
Packit Service 54d9af
--------
Packit Service 54d9af
Synopsis
Packit Service 54d9af
--------
Packit Service 54d9af
Packit Service 54d9af
``dnf groups-manager [options] [package-name-spec [package-name-spec ...]]``
Packit Service 54d9af
Packit Service 54d9af
-----------
Packit Service 54d9af
Description
Packit Service 54d9af
-----------
Packit Service 54d9af
groups-manager plugin is used to create or edit a group metadata file for a repository. This is often much easier than writing/editing the XML by hand. The groups-manager can load an entire file of groups metadata and either create a new group or edit an existing group and then write all of the groups metadata back out.
Packit Service 54d9af
Packit Service 54d9af
---------
Packit Service 54d9af
Arguments
Packit Service 54d9af
---------
Packit Service 54d9af
Packit Service 54d9af
``<package-name-spec>``
Packit Service 54d9af
    Package to add to a group or remove from a group.
Packit Service 54d9af
Packit Service 54d9af
-------
Packit Service 54d9af
Options
Packit Service 54d9af
-------
Packit Service 54d9af
Packit Service 54d9af
All general DNF options are accepted, see `Options` in :manpage:`dnf(8)` for details.
Packit Service 54d9af
Packit Service 54d9af
``--load=<path_to_comps.xml>``
Packit Service 54d9af
    Load the groups metadata information from the specified file before performing any operations. Metadata from all files are merged together if the option is specified multiple times.
Packit Service 54d9af
Packit Service 54d9af
``--save=<path_to_comps.xml>``
Packit Service 54d9af
    Save the result to this file. You can specify the name of a file you are loading from as the data will only be saved when all the operations have been performed. This option can also be specified multiple times.
Packit Service 54d9af
Packit Service 54d9af
``--merge=<path_to_comps.xml>``
Packit Service 54d9af
    This is the same as loading and saving a file, however the "merge" file is loaded before any others and saved last.
Packit Service 54d9af
Packit Service 54d9af
``--print``
Packit Service 54d9af
    Also print the result to stdout.
Packit Service 54d9af
Packit Service 54d9af
``--id=<id>``
Packit Service 54d9af
    The id to lookup/use for the group. If you don't specify an ``<id>``, but do specify a name that doesn't refer to an existing group, then an id for the group is generated based on the name.
Packit Service 54d9af
Packit Service 54d9af
``-n <name>, --name=<name>``
Packit Service 54d9af
    The name to lookup/use for the group. If you specify an existing group id, then the group with that id will have it's name changed to this value.
Packit Service 54d9af
Packit Service 54d9af
``--description=<description>``
Packit Service 54d9af
    The description to use for the group.
Packit Service 54d9af
Packit Service 54d9af
``--display-order=<display_order>``
Packit Service 54d9af
    Change the integer which controls the order groups are presented in, for example in ``dnf grouplist``.
Packit Service 54d9af
Packit Service 54d9af
``--translated-name=<lang:text>``
Packit Service 54d9af
    A translation of the group name in the given language. The syntax is ``lang:text``. Eg. ``en:my-group-name-in-english``
Packit Service 54d9af
Packit Service 54d9af
``--translated-description=<lang:text>``
Packit Service 54d9af
    A translation of the group description in the given language. The syntax is ``lang:text``. Eg. ``en:my-group-description-in-english``.
Packit Service 54d9af
Packit Service 54d9af
``--user-visible``
Packit Service 54d9af
    Make the group visible in ``dnf grouplist`` (this is the default).
Packit Service 54d9af
Packit Service 54d9af
``--not-user-visible``
Packit Service 54d9af
    Make the group not visible in ``dnf grouplist``.
Packit Service 54d9af
Packit Service 54d9af
``--mandatory``
Packit Service 54d9af
    Store the package names specified within the mandatory section of the specified group, the default is to use the default section.
Packit Service 54d9af
Packit Service 54d9af
``--optional``
Packit Service 54d9af
    Store the package names specified within the optional section of the specified group, the default is to use the default section.
Packit Service 54d9af
Packit Service 54d9af
``--remove``
Packit Service 54d9af
    Instead of adding packages remove them. Note that the packages are removed from all sections (default, mandatory and optional).
Packit Service 54d9af
Packit Service 54d9af
``--dependencies``
Packit Service 54d9af
    Also include the names of the direct dependencies for each package specified.