groff-man.7

НАЗВА

groff_man - макроси groff `man' для підтримки генерування сторінок man

ЗВІД

groff -man [ опції... ] [ файли... ]
groff -m man [ опції... ] [ файли... ]

ОПИС

Макроси що дозволяють man програмі генерувати сторінки посібника з допомогою ?groff були написані Джеймсом Кларком. Цей документ надає короткий опис використання кожного макроса у цьому пакеті.

ОПЦІЇ

Макроси програми man розуміють наступні опції командної лінії (ці опції визначають різноманітні регістри).

-rcR=1 : Ця опція (вживається за замовчуванням у ?nroff стані) створить єдину, дуже довгу сторінку замість багатьох сторінок. Використайте -rcR=0 щоб скасувати її.

-rC1 : У випадку якщо більше ніж єдина сторінка посібника вказана на командній лінії, ця опція спричинить порядкову нумерацію сторінок, замість того щоб кожна починалася з номеру 1.

-rD1 : Двосторонній видрук. Нижня примітка парних і непарних сторінок будуть зформатованими по-різному.

-rP_nnn : Відлік сторінок почнеться з nnn_ а не з 1.

-rS_xx : Розмір шрифту базового документу буде xx пунктів (xx_ може бути 10, 11 або 12, за замовчуванням - 10).

-rX_nnn : Після сторінки nnn, позначати решту як nnn_a, nnn_b, nnn_c, і.т.д. Наприклад, опція `-rX2' видасть наступну нумерацію сторінок: 1, 2, 2a, 2b, 2c і.т.д.

ВИКОРИСТАННЯ

Цей розділ описує наявні макроси для сторінок посібника. Для власних налагоджень, додайте нові макроси у файл man.local, який буде завантажено одразу ж після пакету man.

.TH титул розділ [додаткове1] [додаткове2] [додаткове3] : Встановить верхній титульний рядок (колонтитул) сторінки посібника як титул і розділ. Значення розділу може бути у проміжку між 1 і 8. До розділу можна додавати закінчення, наприклад .pm', щоб вказати певний підрозділ сторінок посібника. Обидва, _титул_ і _розділ_ будуть розміщені з лівої і правої сторони титульного рядка (із _розділом_ взятим у дужки і добавленим одразу ж після _титулу_. _Додаткове1_ буде розташоване по центру у нижній примітці, _додаткове2_ - внизу зліва (зліва у парних сторінках і зправа - на непарних, у випадку двосторінкового видруку), _додаткове3_ - по центру колонтитула. Для HTML виводу, титульний рядок і нижня примітка пригнічуються. Це макро починає нову сторінку, кожний новий рядок буде відноситись до сторінки номер 1 (за винятком коли опція-rC1' надана на командній лінії); одна сторінка посібника повинна включати лише одне макро TH на початку файла.

.SH [текст для заголовку] : Встановлює виступаючий уліво ненумерований заголовок розділу. Видруковує жирним шрифтом весь текс що слідує за SH аж до кінця рядка (або весь текст наступного рядка якщо SH не має аргументів). Розмір шрифту є тим самим що й решта документу. На додаток, лівий відступ тексту що слідує буде перезаладований до значення за замовчуванням (скасовує попередні відступи).

.SS [текст для заголовку] : Встановлює другорядний ненумерований заголовок розділу. Видруковує жирним шрифтом весь текст що слідує за SS аж до кінця рядка (або весь текст наступного рядка якщо SS не має аргументів). Розмір шрифту є тим самим що й решта документу. На додаток, лівий відступ тексту що слідує буде перезаладований до значення за замовчуванням (скасовує попередні відступи).

.TP [nnn] : Встановлює етикетку і параграф із відступом управо. Відступ дорівнюватиме nnn, якщо цей аргумент присутній (стандартною одиницею є `n' якщо пропущено), в іншому випадку відступ дорівнюватиме значенню відступа за замовчуванням. Перший рядок що слідує за цим макро буде зсунуто докінця вліво, як і належить етикетці. Цей рядок не розглядається як складова частина параграфа, тож не робитиметься спроба доповнити перший рядок з наступних рядків, як це відбувається у звичайних параграфах. Тим не менш, якщо етикетка є вужчою за відступ параграфа, то текст що за нею слідує почнеться з того самого рядка (зберігаючи відступ), продовжуючись на наступних. Якщо ж текст етикетки ширший за відступ параграфа, тоді описова частина параграфа почнеться на рядку що слідує за поміткою, з відступом вправо. Зауважте, що ні форма штифта, етикетки, ні розмір не є встановленими тоді як решта тексту матиме стандартні встановленя шрифта. TP-макро, як правило, використовується для пояснень яке ви читаєте в дану мить.

.LP
.PP
.P : Ці макроси являються синонімами. Кожен з них викличе розрив рядка у поточній позиції із послідуючим вертикальним пробілом униз на відстань вказану макросом PD. Форма і розмір шрифта будуть перезаладовані до значень за замовчуванням (10pt). Накінець, поточний (стандартний) відступ вправо відновлюється.

У випадку відмінних кодувань і наборів шрифтів, замість \(bu' можете використати англійськуo'.

.IP [позначка] [nnn] : Встановлює зсунутий вправо параграф, використовуючи позначку як мітку де саме він починається. Зсув дорівнюватиме nnn, якщо цей аргумент присутній (стандартною одиницею є n'), у протилежному випадку використовуватиметься значення відступа за замовчуванням. Розмір і стиль шрифта параграфа (але не позначки) перезаладовуються на стандартний. Щоб розпочати параграф з певним відступом вправо але без позначки, використайте""' (пару лапок) як перший аргумент.

Для прикладу, наступні три параграфи були встановлені з кулею як познака, з допомогою `.IP (bu 4':

: o IP є одним з трьох макросів що використовуються man програмою для форматування списків.

: o HP є наступним, це макро створює параграфи з лівостороннім зсувом.

: o TP буде останнім з них. Воно створює етикетку без відступу за якою слідує параграф з відступом вправо.

.HP [nnn] : Встановлює параграф з додатковим лівим відступом. Відступ почнеться після першого рядка і буде nnn ширини, якщо цей аргумент присутній, у протилежному випадку використовуватиметься значення відступа за замовчуванням. Розмір і стиль шрифта перезаладовуються на стандартний. Наступний параграф демонструє дію цього макро, з відступом 4:

: Це параграф що слідує після виклику HP макроса. Як ви бачите, це

: спричиняє параграф у якому всі рядки крім першого зсунуті

: вправо.

.RS [nnn] : Цей макрос переміщає лівий край в праву сторону на nnn, якщо цей аргумент присутній; в протилежному випадку використовується значення зсуву за замовчуванням. Виклики RS макроса можуть бути гніздованими.

.RE [nnn] : Цей макрос переміщає лівий край назад на nnn рівень; якщо не надано аргументу - переміщає одним рівнем назад. Перший рівень (тобто не було ще виклику RS) числиться під номером 1, і кожний виклик RS збільшує це значення на 1.

Як висновок, наступні макроси спричинюють розрив рядка з вставленим вертикальним пробілом (кількість якого можна регулювати з допомогою макроса PD): SH, SS, TP, LP (PP, P), IP і HP. Макроси RS та RE також зумовлюють розрив рядка, але без вертикального пробілу.

МАКРОСИ ДЛЯ ВСТАНОВЛЮВАННЯ ШРИФТУ

Стандартним шрифтом є Roman, стандартним розміром шрифта - 10 пунктів (1/72 дюйма).

.SH [текст] : Виводить текст на тому самому рядку або на наступному на один пункт менший розміром ніж розмір шрифта за замовчуванням.

.SB [текст] : Виводить жирним шрифтом текст на тому самому рядку або на наступному, розмір шрифта також на один пункт менший ніж за замовчуванням.

.BI текст : Виводить текст на тому самому рядку почергово жирним шрифтом або курсивом. Текст повинен знаходитись на тому самому рядку що і виклик макроса. Таким чином,

.BI це "слово і" те

виведе це' iте' жирним шрифтом, тоді як `слово і' - курсивом.

.IB текст : Виводить текст на тому самому рядку почергово жирним шрифтом або курсивом. Текст повинен знаходитись на тому самому рядку що і виклик макроса.

.RI текст : Виводить текст на тому самому рядку почергово у Roman або курсивом. Текст повинен знаходитись на тому самому рядку що і виклик макроса.

.IR текст : Виводить текст на тому самому рядку почергово курсивом або у Roman. Текст повинен знаходитись на тому самому рядку що і виклик макроса.

.BR текст : Виводить текст на тому самому рядку почергово жирним шрифтом або у Roman. Текст повинен знаходитись на тому самому рядку що і виклик макроса.

.RB текст : Виводить текст на тому самому рядку почергово у Roman або жирним шрифтом. Текст повинен знаходитись на тому самому рядку що і виклик макроса.

.R [текст] : Виводить текст у Roman гарнітурі. Якщо текст відсутній на тому самому рядку що й макрос, тоді текст на наступному рядку з'явиться у Roman. Це гарнітура за замовчуванням до якої текст повернеться після закінчення обробки інших макросів.

.B [текст] : Виводить текст жирним шрифтом. Якщо текст відсутній на тому самому рядку що й макрос, тоді текст на наступному рядку з'явиться жирним шрифтом.

.I [текст] : Виводить текст курсивом. Якщо текст відсутній на тому самому рядку що й макрос, тоді текст на наступному рядку з'явиться курсивом.

РІЗНЕ

Відступ за замовчуванням буде 7.2n для всіх приладів, за винятком grohtml, що ігнорує відступи.

.br : Викличе розрив поточного рядка.

.sp [nnn] : Викличе розрив поточного рядка на nnn відстань.

\f[B|I|P|R] : Встановлює шрифт ланцюжка що за ним слідує до жирного (B), курсива (I), стандартного (P) або Roman (R). Так, наприклад `\fIслово\fR' виведе слово курсивом і решту рядка у Roman.

.DT : Встановлює крок табуляції 0.5 інчів. Оскільки цей макрос завжди викликається під час звертання до TH, має зміст викликати DT тільки у випадку коли крок табуляції було змінено.

Необов'язковий аргумент вказує скільки саме відступити вниз (одиницями за замовчуванням є `v'); без жодних параметрів, значення буде перезаладоване на стандартне (1 рядок для tty приладів i 0.v для решти). Це впливатиме на макроси SH, SS, TP, LP (PP, P), IP та HP.

.PD [nnn] : Налагоджує порожній простір перед новим параграфом.

Наступні рядки є встановленими:

*S : Скине розмір шрифта до стандартного.

*R : Знак реєстрації.

*(Tm : Знак торгової марки.

*(lq
*(rq : Ліві і праві лапки. Це дорівнює відповідним \(lq' і(rq'.

Якщо необхідний препроцесор, такий як ?tbl або ?eqn, стало поширеним робити перший рядок сторінки посібника як:

.\" слово

Зверніть увагу на один пробіл після подвійних лапок. Слово складається з знаків, необхідних препроцесору: e' для **<a href="/cgi-bin/ikiwiki.cgi?page=man%2Fman1%2Feqn.1&from=man%2Fman7%2Fgroff-man.7&do=create" rel="nofollow">?</a>eqn**,r' для ?refer, `t' для ?tbl. Сучасні втілення man програми читають цей перший рядок і автоматично викликають відповідний препроцесор.

ФАЙЛИ

man.tmac
an.tmac : Ці файли відіграють роль обгорток для того щоб викликати andoc.tmac.

andoc.tmac : Цей файл перевіряє чи вживаються макроси man, чи необхідно використати пакет ?mdoc.

an-old.tmac : Всі макроси man містяться у цьому файлі.

man.local : Місцеві зміни і налаштування повинні бути поміщеними у цей файл.

ДИВІТЬСЯ ТАКОЖ

Оскільки макроси man складаються з набору запитів ?groff, є можливим замінити функціональність макросів man індивідуальними викликами ?groff, якщо необхідно. Повний список запитів можна знайти на

http://www.cs.pdx.edu/~trent/gnu/groff/groff_toc.html

?tbl(1), ?eqn(1), ?refer(1), man(1)

АВТОР

Ця сторінка посібника була написана Сюзаною Г. Клейнман sgk@debian.org для Debian GNU/Linux. Поправки і доповнення зроблені Вернером Лембергом wl@gnu.org. Тепер цей посібник є частиною дистрибутиву GNU troff.

Переклав українською Віталій Цибуляк vi@uatech.atspace.com