cli-generate - онлайн в облаке

ПРОГРАММА:

ИМЯ

cli-generate - генерирует исходный код и документацию из описаний интерфейса командной строки.

СИНТАКСИС

cli-генерировать [ -c | -h | -m | -w ] ИМЯ ФАЙЛА.cli

ОПИСАНИЕ

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

Файл CLI (названный ПРОГРАММА.кли) разделен на две части: заголовок (форматированный как
стандартный почтовый заголовок) и ряд разделов. Заголовки и разделы кроме этих
указанные ниже игнорируются. Все заголовки и разделы необязательны.

Файл Формат
file = header "\ n" * раздел

header = * (строка заголовка "\ n")

header-line = поле-заголовка ":" значение пробела

пробел = * (ПРОБЕЛ / ТАБУЛЯЦИЯ)

section = "[" name "]" "\ n" строк

lines = * (строка "\ n")

Заголовки
Описание:
Однострочное описание того, что делает программа.

Включают:
Добавьте операторы C в #include указанного исходного файла. Должен быть отформатирован как
or файл

Мин: Минимальное количество разрешенных аргументов, не являющихся опциями. По умолчанию 0.

Макс: Максимальное количество разрешенных аргументов, не являющихся опциями. Отрицательные значения означают
безлимитный. По умолчанию -1.

Показать-Pid:
Установите ненулевое значение, если результирующая программа должна показывать свой PID с каждым выходом.
сообщение. По умолчанию 0.

Применение: Однострочное описание предполагаемого использования. По умолчанию пусто.

Раздел имен
[приставка]
Текст в этом разделе показан в использовании команды перед параметрами.
описание.

[опции]
Список опций, которые принимает эта программа. См. Ниже их формат.

[суффикс]
Текст в этом разделе отображается в использовании команды после параметров
описание.

[Описание]

[возвращение ценить]

[ошибки]

[Примеры]

[среда]

[файлы]

[видеть также]

[Примечания]

[предостережения]

[диагностика]

[ошибки]

[ограничения]

[автор]

[история]
Эти разделы форматируются и копируются на страницу руководства в стандартном порядке.

Опции Формат
options = * (параметр / разделитель)

option = option1 "\ n" option2 "\ n" * (строка "\ n")

option1 = [shorttopt] [longopt] тип ["=" значение флага] переменная ["=" init]

option2 = helpstr ["=" по умолчанию]

separator = "-" текст "\ n"

shorttopt = "-" символ

longopt = "-" слово

type = "FLAG" / "COUNTER" / "INTEGER" / "UINTEGER" / "STRING" / "STRINGLIST" / "FUNCTION"

Если не указано, значение флага и инициализации Он 0и по умолчанию пусто.

форматирование
За исключением [приставка], [опции]и [суффикс], все разделы поддерживают форматирование
инструкции аналогичны TeXinfo (но сильно упрощены).

@strong {текст}
Используйте «сильный» (жирный) текст.

@command {текст}
Укажите название команды.

@option {текст}
Укажите параметр командной строки.

@emph {текст}
Используйте «подчеркнутый» (курсивный) текст.

@var {текст}
Укажите метасинтаксическую переменную.

@env {текст}
Укажите переменную среды.

@ файл {текст}
Укажите имя файла.

@code {текст}
Укажите текст, который является буквальным примером фрагмента программы.

@samp {текст}
Укажите текст, который представляет собой буквальный пример последовательности символов.

@пример

@конец пример
Текст между этими двумя тегами имеет отступ.

@вербатим

@конец дословно
Все, что находится между этими двумя тегами, передается на вывод как есть (дословно).

@стол @формат

@конец ТАБЛИЦЫ
Разметьте таблицу из двух столбцов или «список определений».

@элемент пункт
Добавьте элемент в таблицу. В @элемент начинает абзац, который будет фактическим списком
Вход. Все последующие абзацы будут набираться отдельно.

ДОПОЛНИТЕЛЬНЫЕ УСЛУГИ, НЕ ВКЛЮЧЕННЫЕ В ПАКЕТ

-c Вывести исходный код C.

-h Выходной файл заголовка C.

-m Выведите справочную страницу UNIX.

-w Выводить разметку HTML (веб).

ПРИМЕРЫ

Вот пример файла CLI, содержащего многие из описанных элементов.

Мин: 1
Макс: 1
Использование: ПУТЬ
Описание: Создать файл.
Показать-Pid: 0
Включают:

[приставка]
Если данный PATH является каталогом, к нему добавляется другой суффикс.

[Описание]
@program генерирует новый случайный файл из множества источников, включая
@command {ls} и @command {ps} вывод.

Если заданный @option {PATH} является каталогом, к нему добавляется другой суффикс.
имя по моему выбору.

[опции]
-v --verbose ФЛАГ = 1 opt_verbose

-t --type STRING opt_type = "тип1"
Тип создаваемого файла. = type1
Возможные типы для этого включают @option {type1} и @option {base64}.

Используйте cli-generate онлайн с помощью сервисов onworks.net