Это команда update-yorickdoc, которую можно запустить в провайдере бесплатного хостинга OnWorks, используя одну из наших многочисленных бесплатных онлайн-рабочих станций, таких как Ubuntu Online, Fedora Online, онлайн-эмулятор Windows или онлайн-эмулятор MAC OS.
ПРОГРАММА:
ИМЯ
update-yorickdoc - Создание HTML-документации для Йорика
СИНТАКСИС
обновление-yorickdoc [--conf =файл] [--авто] [--авто-сейчас] [--from =каталог] [--to =каталог]
[--xref-dir =каталог] [--src-dir =каталог] [--template =файл]
ОПИСАНИЕ
update-yorickdoc - это оболочка для htmldoc.i, скрипта Yorick, который извлекает ДОКУМЕНТ
комментарии из исходных файлов Yorick и превращает их в набор файлов HTML.
update-yorickdoc объединяет файлы из «исходного каталога» (по умолчанию: / usr / share / yorick-doc,
параметр командной строки: --src-dir), удаляет целевой каталог (по умолчанию:
/ usr / share / doc / yorick-doc / html_xref), и, если Yorick установлен, вызывает "yorick -batch
htmldoc.i "для компиляции HTML-документации для всех установленных на данный момент функций (либо
из основного пакета Yorick или из дополнительных пакетов).
update-yorickdoc предназначен для автоматического вызова всякий раз, когда пакет Yorick
установлен или удален. Можно запретить автоматические обновления, установив "ENABLE_AUTO"
до 0 в / etc / yorick-doc. Также можно использовать update-yorickdoc вручную для создания
документация из пользовательских каталогов (например, из собственных ~ / Йорик / каталог) или в
заказное место, например.
update-yorickdoc имеет набор параметров по умолчанию для работы. Эти параметры
перезаписывается в хронологическом порядке содержимым / etc / yorick-doc, $ HOME / .yorick-doc и
командная строка.
Для работы этого сценария требуется несколько файлов. Файлы по умолчанию представлены в
исходный каталог по умолчанию, а дополнительные пакеты должны предоставлять дополнительную информацию в
то же самое место. Видеть FILES ниже, а также /usr/share/doc/yorick-dev/yorick-policy.gz.
ДОПОЛНИТЕЛЬНЫЕ ОПЦИИ
--авто | -a
Этот флаг устарел с появлением триггеров в dpkg. В системах, где dpkg
поддерживает триггеры, -a превращает update-yorickdoc в запретную. В старых системах это
ведет себя как -A ниже.
--авто-сейчас | -A
Этот флаг предназначен для использования только в сценарии postinst пакета yorick-doc,
который должен запускаться каждый раз, когда дополнительный пакет yorick
установлен, обновлен или удален. Можно превратить update-yorickdoc в запретный
когда этот флаг установлен установкой ENABLE_AUTO на 0 в / etc / yorick-doc.
--conf =файл
Прочтите конфигурацию из этого файла. Этот файл анализируется, поскольку параметр находится на
командная строка, перезаписывая предыдущие параметры.
--from =каталог1: каталог2 ...
Разделенный двоеточиями список каталогов для сканирования файлов Yorick. Дефолт:
/ usr / share / yorick / i: / usr / share / yorick / i0.
--purge | -p
Удалите только / usr / share / doc / yorick-doc / html_xref (или каталог, установленный с помощью --to и
--xref-dir или эквивалентные переменные в / etc / yorick-doc), не перестраивать
документация впоследствии.
--тихий | -q
Молчи, только вкратце расскажу, что делает update-yorickdoc. Это встроенный
по умолчанию, но могло быть переопределено в файле конфигурации.
--src-dir =каталог
Каталог, содержащий файлы .packinfo, .keywords и .aliases при создании
документация. Каждый из этих трех типов файлов будет объединен в
в лексикографическом порядке и передается на htmldoc.i с использованием --packinfo, --keywords и
Параметры --aliases (см. htmldoc.i). По умолчанию: / usr / share / yorick-doc.
--template =файл
Файл шаблона для htmldoc.i. Правильный формат подробно описан на htmldoc.i. Дефолт:
/usr/share/yorick-doc/template.html.
--to =каталог
Каталог верхнего уровня иерархии Yorick HTML для обновления. Это на один уровень выше
каталог, который будет удален и / или (пере) построен. По умолчанию
/ usr / share / doc / yorick-doc.
--подробный | -v
Будьте многословны, выводя много отладочной информации. Встроенное значение по умолчанию должно быть
Тихо, просто коротко расскажу, что делает update-yorickdoc.
--xref-dir =слово
Подкаталог каталога «TO», в котором будет скомпилирована документация. Определенный
гиперссылки в документации будут использовать это значение. Это не должно быть установлено на
каталог, содержание которого вы цените, поскольку этот каталог будет сначала удален. Дефолт:
html_xref.
Используйте update-yorickdoc в Интернете с помощью сервисов onworks.net
