8.4.5 Перечисление параметров

Каждый компонент содержит один или более параметров. Параметры могут объединяться в группы, чтобы пользовательская оболочка могла подсказывать пользователю, какие параметры связаны друг с другом.

Команда --list-options компонент перечисляет все параметры (и группы, в которые они входят) заданного компонента по одному в строке. Компонент должен задаваться именем, которое выводится командой --list-components.

Каждая группа и каждый параметр выводятся в отдельной строке. Сначала идут все параметры, не входящие ни в одну из групп. Затем идет строка с описанием группы. После этого идут все параметры, входящие в эту группу. Дальше идет следующая группа и так далее. Групп может и не быть (в этом случае перечисление завершается выводом последнего параметра, не входящего ни в одну из групп).

Строки имеют вид:

имя:признаки:уровень:описание:тип:доп-тип:имя аргумента:исходное:исх.арг:значение

имя

В этом поле содержится именная метка группы или параметра. Она используется для указания группы или параметра во всяком обмене с gpgconf. Именную метку следует использовать буквально. Таким образом, в ее формате нет никаких экранирующих символов.

признаки

Поле содержит беззнаковое число. Его величина представляет побитовое ИЛИ следующих признаков:

группа (1)

Если установлен этот признак, строка описывает группу, а не параметр.

Следующие значения признаков определены только для параметров (то есть если признак группа не установлен).

необязательный аргумент (2)

Если признак установлен, аргумент не обязателен. Признак никогда не устанавливается, если тип равен 0 (параметр без аргумента).

список (4)

Если этот признак установлен, параметр можно задавать несколько раз.

без перезапуска (8)

Если этот признак установлен, параметр можно менять во время работы программы.

исходное (16)

Если этот признак установлен, у параметра есть исходное значение.

рабочее исходное (32)

Если этот признак установлен, у параметра есть исходное значение во время работы программы. Этот признак и исходное взаимно исключают друг друга.

безаргументный (64)

Если этот признак установлен вместе с признаком необязательный аргумент, то параметр имеет особый смысл, если не сопровождается аргументом.

константа (128)

Если этот признак установлен, gpgconf игнорирует запросы на изменение этого параметра. Пользовательские оболочки должны отражать невозможность изменения. Обратите внимание, что файлы настроек все равно можно править вручную.

уровень

Это поле определено для параметров и для групп. Оно содержит беззнаковое число, указывающее уровень опыта, под которым следует отображать эту группу или параметр. Определены следующие уровни опыта:

простейший (0)

Элемент следует предлагать пользователю всегда.

усложненный (1)

Элемент можно предлагать опытным пользователям.

экспертный (2)

Элемент следует предлагать только экспертам.

невидимый (3)

В обычных ситуациях элемент отображать не следует — даже для экспертов.

внутренний (4)

Этот элемент предназначен только для внутреннего пользования. Игнорируйте его.

Уровень группы всегда является минимальным уровнем всех входящих в нее параметров.

описание

Это поле определено для параметров и групп. Это строка, содержащая описание элемента, предназначенное для человека. Она может отображаться в пользовательской оболочке в информационных целях. Она экранирована процентом и переводима.

тип

Это поле определено только для параметров. Оно содержит беззнаковое число, которое определяет тип аргумента (и существует ли он). Определены типы:

Простые типы:

пустой (0)

Аргумент недопустим.

строка (1)

Аргумент — неформатированная строка.

int32 (2)

Аргумент — число со знаком.

uint32 (3)

Аргумент — беззнаковое число.

Сложные типы:

путь в файловой системе (32)

Это строка, в которой записан путь до файла. Файл не обязательно существует.

сервер LDAP (33)

Это строка, в которой описан сервер LDAP в виде:

имя сервера:порт:имя пользователя:пароль:база поиска

отпечаток ключа (34)

Это строка с 40-значным отпечатком, определяющим сертификат.

открытый ключ (35)

Это строка, которая задает сертификат идентификатором пользователя, идентификатором ключа или отпечатком.

секретный ключ (36)

Это строка, которая задает сертификат с секретным ключом идентификатором пользователя, идентификатором ключа или отпечатком.

список группы (37)

Это строка, которая задает список группы, как при использовании параметра --group gpg. Список состоит из имени, знака равенства и разделенных пробелом значений.

В дальнейшем будут добавляться новые типы. О том, как обрабатывать неизвестные типы, см. в описании доп-тип.

доп-тип

Это поле идентично полю тип, но в нем допустимы значения только от 0 до 31. Пользовательская оболочка должна представлять пользователю параметр в формате, указанном в поле тип. Но если аргумент данного типа не поддерживается оболочкой, она может представить его в более общем простом типе, указанном в поле доп-тип. Пользовательская оболочка должна поддерживать все определенные здесь простые типы, чтобы можно было отображать все параметры. В дальнейшем будут добавляться новые простые типы. Если пользовательская оболочка встречает основной тип, который она не поддерживает, она должна сообщить об ошибке и отменить операцию.

имя аргумента

Это поле определено только для параметров с типом аргумента тип, отличным от 0. В этом случае оно может содержать экранированную процентом строку, которая переводима и в которой указано краткое имя аргумента. Поле также может быть пустым, это значит, что краткое имя не известно.

исходное

Это поле определено только для параметров, для которых установлен признак исходное или рабочее исходное. Если установлен признак исходное, формат поля соответствует аргументу параметра (см. Формат). Если исходное значение пусто, то оно считается неизвестным. В противном случае содержимое поля указывает исходное значение этого параметра. Если установлен признак рабочее исходное, то поле либо пусто, либо определяет значение параметра, когда он не задан.

исх.арг

Это поле определено только для параметров, для которых установлен признак необязательный аргумент. Если не установлен признак безаргументный, его формат соответствует параметру (см. Формат). Если исходное значение пусто, то оно считается неизвестным. В противном случае поле определяет исходное значение аргумента этого параметра. Если признак безаргументный установлен, то поле либо пусто, либо определяет значение аргумента параметра, когда он не задан.

значение

Это поле определено только для параметров. Его формат соответствует аргументу параметра. Если оно пусто, то параметр в явном виде в текущих настройках не указан и действуют исходные значения (если они есть). В противном случае он содержит текущее значение параметра. Обратите внимание, что это поле имеет смысл и в том случае, если у самого параметра настоящего аргумента нет (в этом случае в поле указано, сколько раз параметр появляется в строке).