DNF5-ALIASES(7)

BEZEICHNUNG
dnf5-aliases - Aliase für Befehlszeilenargumente

BESCHREIBUNG

Es ist möglich, eigene Aliase zu definieren, welche dann als dnf(5)-Befehle oder Optionen verwendet werden können, um längere Befehls- und Optionssequenzen abzukürzen.

Die Aliase können im TOML-Format konfiguriert werden. Die Konfigurationsdateien werden aus folgenden Ergänzungsverzeichnissen geladen:

            •   /usr/share/dnf5/aliases.d/

            •   /etc/dnf/dnf5-aliases.d/

            •   $XDG_CONFIG_HOME/dnf5/aliases.d/

  Syntax:

Die Konfigurationsdatei muss mit dem Attribut version beginnen, das auf die erforderliche Version gesetzt ist, zum Beispiel:

            version = '1.1'

Jeder Alias ist in einem separaten Abschnitt als Schlüssel = Wert-Paar definiert, zum Beispiel:

            ['in']
            type = 'command'
            attached_command = 'install'
            descr.C = "Alias for 'install'"
            descr.de_DE = "Alias für 'install'"

Der Abschnittsname definiert den Alias eindeutig. Er ist als Pfad formatiert, das heißt, eine Zeichenkette oder mehrere, durch Punkte getrennt. Sie definieren den Bereich des Alias. Beispielsweise identifiziert die Zeichenkette »group.list.in« einen Alias, der nur innerhalb des Bereichs des Unterbefehls group list verwendet werden kann.

Es gibt die folgenden Aliastypen:

            •   command

            •   cloned_named_arg

            •   named_arg

            •   group

  Typ: command

Der command-Alias definiert einen Alias für einen Befehl.

    Schlüssel:

        •   type - Muss den Wert command haben.

        •   attached_command - Pfad zu einem Befehl, für den dieser Alias definiert ist.

        •   descr.<Locale> - Beschreibung, die in der Hilfe angezeigt wird. descr.C wird verwendet, falls eine Kopfzeile für die entsprechende Locale nicht gefunden wird. Wurde in der Konfigurationsdateiversion 1.1 hinzugefügt.

        •   descr - Beschreibung, die in der Hilfe angezeigt wird. Wurde in Version 1.1 als veraltet markiert, aber verbleibt zwecks Abwärtskompatibilität. Locales werden nicht unterstützt.

        •   group_id - Eine Gruppe, zu der dieser Alias gehört, falls zutreffend.

        •   complete - Gibt an, ob die Autovervollständigung der bash(1) für diesen Alias genutzt werden soll; die Vorgabe ist »false« (falsch).

        •   required_values - Werte (positionale Argumente), die vom Befehls-Alias verarbeitet werden. Das Format ist ein Feld aus Tabellen; jede davon muss entweder value_help.<Locale> für die aktive Locale oder value_help.C enthalten. Optional kann descr.<Locale> enthalten sein. Die Vorgabe ist ein leeres Feld. Wurde in der Konfigurationsdateiversion 1.1 hinzugefügt.

        •   attached_named_args - Optionen, die vom Befehl verwendet werden. Das Format ist ein Feld aus Tabellen, wovon jede einen id_path-Schlüssel enthalten muss, der den Pfad zu einer Option angibt. Weiterhin kann auch ein value-Schlüssel enthalten sein, der den Wert der Option angibt. Der value-Schlüssel kann ${index}-Platzhalter enthalten, die durch Werte ersetzt werden, die vom Befehlsalias verarbeitet werden (wie von required_values definiert). Befehlsargumente beginnen beim Index 1. Index 0 bezieht sich auf den Befehlsalias selbst. Falls kein value-Schlüssel angegeben wird, wird eine leere Zeichenkette an benannte Argumente übergeben, die einen Wert erwarten.

Die erforderlichen Schlüssel sind type und attached_command.

    Beispiele:

        •   Alias grouplist für group list:

                    ['grouplist']
                    type = 'command'
                    attached_command = 'group.list'
                    descr.C = "Alias for 'group list'"
                    descr.de_DE = "Alias für 'group list'"

        •   Alias group.ls für group list:

                    ['group.ls']
                    type = 'command'
                    attached_command = 'group.list'
                    descr.C = "Alias for 'group list'"
                    descr.de_DE = "Alias für 'group list'"
                    complete = true

        •   Alias list-fedora-all für --repo=fedora list --showduplicates:

                    ['list-fedora-all']
                    type = 'command'
                    attached_command = 'list'
                    descr.C = "Alias for '--repo=fedora list --showduplicates'"
                    descr.de_DE = "Alias für '--repo=fedora list --showduplicates'"
                    complete = true
                    attached_named_args = [
                        { id_path = 'repo', value = 'fedora' },
                        { id_path = 'list.showduplicates' }
                    ]

        •   Alias whatrequires für repoquery --installed --whatrequires=<erfordert_erstes_Argument>:

                    ['whatrequires']
                    type = 'command'
                    attached_command = 'repoquery'
                    descr = 'Alias für "repoquery --installed --whatrequires=<whatrequires_first_argument>"'
                    complete = true

                    [[whatrequires.required_values]]
                    value_help.C = 'CAPABILITY,...'
                    descr.C = 'Limit to packages that require any of <capabilities>.'
                    descr.de_DE = 'Auf Pakete begrenzen, die irgendwelche <Capabilities> benötigen.'

                    [[whatrequires.attached_named_args]]
                    id_path = 'repoquery.installed'

                    [[whatrequires.attached_named_args]]
                    id_path = 'repoquery.whatrequires'
                    value='${1}'

  Typ: cloned_named_arg

Der Alias cloned_named_arg definiert einen anderen Namen für eine angegebene Option.

    Schlüssel:

        •   type - Muss den Wert cloned_named_arg haben.

        •   long_name - Name der Alias-Option.

        •   short_name - Ein einzelner Buchstabe als Kürzel des Namens.

        •   source - Pfad zu der Option, für welche dieser Alias definiert ist.

        •   group_id - Eine Gruppe, zu der dieser Alias gehört, falls zutreffend.

        •   complete - Gibt an, ob die Autovervollständigung der bash(1) für diesen Alias genutzt werden soll; die Vorgabe ist »false« (falsch).

Die erforderlichen Schlüssel sind type, entweder long_name oder short_name, und source.

    Beispiele:

        •   Alias --nobest für --no-best:

                    ['nobest']
                    type = 'cloned_named_arg'
                    long_name = 'nobest'
                    source = 'no-best'

        •   Alias repoquery --list oder repoquery -l für repoquery --files:

                    ['repoquery.list']
                    type = 'cloned_named_arg'
                    long_name = 'list'
                    short_name = 'l'
                    source = 'repoquery.files'

  Typ: named_arg

named_arg definiert einen Alias, der mehrere Optionen ersetzen und einen Wert für jede Option definieren kann.

    Schlüssel:

        •   type - Muss den Wert named_arg haben.

        •   long_name - Name der Alias-Option.

        •   short_name - Ein einzelner Buchstabe als Kürzel des Namens.

        •   descr.<Locale> - Beschreibung, die in der Hilfe angezeigt wird. descr.C wird verwendet, falls eine Kopfzeile für die entsprechende Locale nicht gefunden wird. Wurde in der Konfigurationsdateiversion 1.1 hinzugefügt.

        •   descr - Beschreibung, die in der Hilfe angezeigt wird. Wurde in Version 1.1 als veraltet markiert, aber verbleibt zwecks Abwärtskompatibilität. Locales werden nicht unterstützt.

        •   has_value - Gibt an, ob die Option einen Wert erfordert. Der Wert wird dann für ${}-Zeichenketten in den Werten von attached_named_args ersetzt. Vorgabe ist »false« (falsch).

        •   value_help.<Locale> - Die Zeichenkette, die in der Hilfe für den Wert angezeigt wird (zum Beispiel CONFIG_FILE_PATH für --config=CONFIG_FILE_PATH). value_help.C wird verwendet, falls eine Zeichenkette für die entsprechende Locale nicht gefunden wird. Wurde in der Konfigurationsdateiversion 1.1 hinzugefügt.

        •   value_help - Die Zeichenkette, die in der Hilfe für den Wert angezeigt wird (zum Beispiel CONFIG_FILE_PATH für --config=CONFIG_FILE_PATH). Wurde in Version 1.1 als veraltet markiert, aber verbleibt zwecks Abwärtskompatibilität. Locales werden nicht unterstützt.

        •   const_value - Vorgegebener Konstantwert (wird nur angegeben, wenn der Alias keinen Wert in der Befehlszeile hat). Der Wert wird dann für die Ersetzung von ${}-Zeichenketten in den Werten von attached_named_args verwendet.

        •   group_id - Eine Gruppe, zu der dieser Alias gehört, falls zutreffend.

        •   complete - Gibt an, ob die Autovervollständigung der bash(1) für diesen Alias genutzt werden soll; die Vorgabe ist »false« (falsch).

        •   attached_named_args - Optionen, die verwendet werden. Das Format ist ein Feld aus eingefügten Tabellen, wovon jede einen id_path-Schlüssel zur Angabe eines Pfades als Option enthält. Weiterhin kann sie auch einen value-Schlüssel enthalten, der den Wert der Option angibt.

Die erforderlichen Schlüssel sind type und entweder long_name oder short_name.

    Beispiele:

        •   Alias list --all-available für list --showduplicates --available:

                    ['list.all-available']
                    type = 'named_arg'
                    long_name = 'all-available'
                    attached_named_args = [
                        { id_path = 'list.showduplicates' },
                        { id_path = 'list.available' }
                    ]

        •   Alias download --dest=ZIELVERZEICHNIS für download --destdir=ZIELVERZEICHNIS:

                    ['download.dest']
                    type = 'named_arg'
                    long_name = 'dest'
                    has_value = true
                    value_help.C = 'ZIELVERZEICHNIS'
                    attached_named_args = [
                        { id_path = 'download.destdir' }
                    ]

        •   Alias --settsflags=TS-SCHALTER für --setopt=tsflags=TS-SCHALTER:

                    ['settsflags']
                    type = 'named_arg'
                    long_name = 'settsflags'
                    descr.C = 'Set transaction flags'
                    descr.de_DE = 'Transaktionsschalter setzen'
                    has_value = true
                    value_help.C = 'TRANSAKTIONSSCHALTER'
                    attached_named_args = [
                     { id_path = 'setopt', value = 'tsflags=${}' }
                    ]

  Typ: group

group definiert eine Gruppe für mehrere Befehle oder Optionen.

    Erforderliche Schlüssel:

        •   type - Muss den Wert group haben.

        •   header.<Locale> - Die Kopfzeile der Gruppe, wie sie in der Hilfe angezeigt wird. header.C wird verwendet, falls eine Kopfzeile für die entsprechende Locale nicht gefunden wird. Wurde in der Konfigurationsdateiversion 1.1 hinzugefügt.

        •   header - Die Kopfzeile der Gruppe, wie sie in der Hilfe angezeigt wird. Wurde in Version 1.1 als veraltet markiert, aber verbleibt zwecks Abwärtskompatibilität. Locales werden nicht unterstützt.

Die erforderlichen Schlüssel sind type und header.

Die Aliase werden zur Gruppe mit dem Schlüssel group_id in den entsprechenden Abschnitten hinzugefügt.

    Beispiele:

        •   Die Gruppe query-aliases für den Unterbefehl repo anlegen, welche die Aliase repo.ls und repo.if enthält:

                    ['repo.query-aliases']
                    type = 'group'
                    header.C = 'Query Aliases:'
                    header.de_DE = 'Abfrage-Aliase:'

                    ['repo.ls']
                    type = 'command'
                    attached_command = 'repo.list'
                    descr.C = "Alias for 'repo list'"
                    descr.de_DE = "Alias für 'repo list'"
                    group_id = 'query-aliases'

                    ['repo.if']
                    type = 'command'
                    attached_command = 'repo.info'
                    descr.C = "Alias for 'repo info'"
                    descr.de_DE = "Alias für 'repo info'"
                    group_id = 'query-aliases'

Autor
Siehe AUTHORS.md in der dnf5-Quelldistribution.

Copyright
Mitwirkende am DNF5-Projekt.

ÜBERSETZUNG
Die deutsche Übersetzung dieser Handbuchseite wurde von Mario Blättermann <mario.blaettermann@gmail.com> erstellt.

Diese Übersetzung ist Freie Dokumentation; lesen Sie die GNU General Public License Version 3 (https://www.gnu.org/licenses/gpl-3.0.html) oder neuer bezüglich der Copyright-Bedingungen. Es wird KEINE HAFTUNG übernommen.

Wenn Sie Fehler in der Übersetzung dieser Handbuchseite finden, schicken Sie bitte eine E-Mail an die Mailingliste der Übersetzer (debian-l10n-german@lists.debian.org).