Lx4U-book/docs/prologue/typography.md
2021-12-25 14:07:28 +03:00

2.5 KiB
Raw Blame History

Принятые обозначения

В руководстве используются следующие обозначения:

./configure --prefix=/usr

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

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

CC="gcc -B/usr/bin/" ../binutils-2.18/configure \
  --prefix=/tools --disable-nls --disable-werror

Обратите внимание, что после обратного слэша должен быть перевод строки. Другие символы приведут к некорректному результату.

install-info: unknown option '--dir-file=/mnt/lin/usr/info/dir

Этот текст показывает вывод результатов на экран.

Используется чтобы подчеркнуть важную информацию, на которую следует обратить внимание.

Используется для ссылок на страницы проекта, а также на внешние источники. Может включать справочную информацию, ссылки на загрузки и различные сайты.

???+ note "Обратите внимание" Используется для указания на информацию рекомендательного характера. Не пропускайте эти указания и внимательно с ними ознакомьтесь.

???+ warning "Предупреждение" Используется для указания на информацию, несоблюдение которой может потенциально привести к непрогнозируемым последствиям.

???+ danger "Важно" Используется для указания на критически важную информацию, на которую следует обратить особое внимание.