groff_me(7)

Nazwa
groff_me - pakiet makr „me” do formatowania dokumentów roff

Składnia
groff -me [opcja ...] [plik ...]
groff -m me [opcja ...] [plik ...]

Opis
Implementacja GNU pakietu makr me jest częścią systemu formatowania dokumentów groff. Pakiet definicji makr me do języka roff zapewnia dogodne funkcje do przygotowywania dokumentów technicznych w różnych formatach. Niniejsza wersja powstała w oparciu o me dostarczane z 4.4BSD i może być używana z programem formatującym GNU troff oraz tymi, które wywodzą się z AT&T troff.

Niektóre żądania formatowania wpływają w sposób nieprzewidywalny na wygląd strony, gdy są używane łącznie z niniejszym pakietem, jednak poniższe mogą być używane bez problemu po wystąpieniu pierwszego wywołania makra akapitowego, takiego jak lp lub pp. Niektóre argumenty są opcjonalne; w podręczniku groff(7) zawarto więcej informacji, szczególnie na temat żądań, których listę argumentów oznaczono wielokropkiem. Asterysk * oznacza rozszerzenia groff.

ad | c | ustawia dostosowanie tekstu na c
af | r f | przypisuje format f do rejestru r
am | m e | dołącza makro m do momentu wywołania e
as | s t | dołącza resztę wiersza t do łańcucha s
bp | n | rozpoczyna nową stronę o numerze n
br |  | przełamuje w tym miejscu wiersz wyjściowy
ce | n | środkuje następne n wierszy wyjściowych
cp | n | wł./wył. tryb kompatybilności AT&T troff*
de | m e | definiuje makro m do momentu wywołania e
do | t | interpretuje wejście t z wyłączonym trybem kompatybilności*
ds | s t | definiuje resztę wiersza t jako łańcuch s
el | t | interpretuje t jeśli towarzyszące ie jest fałszywe
fc | c d | ustawia rozgranicznik pól na c i glif wyrównania na d
fi |  | włącza wypełnianie
hc | c | ustawia znak dzielenia wyrazów na c
hy | m | ustawia auomatyczny tryb dzielenia na m
ie | p t | jak if, lecz włącza interpretację późniejszych el
if | p t | jeśli warunek p, to interpretuje resztę wiersza t
in | h | ustawia wcięcie na h
lc | c | ustawia glif powtarzania linii odniesienia na c
ls | n | ustawia rozstaw wiersza na n
mc | c h | ustawia (prawy) margines glifu na c w odległości h
mk | r | oznacza pionową pozycję w rejestrze r
na |  | wyłącza dostosowywanie tekstu
ne | v | wymaga pionowej przestrzeni w odległości v
nf |  | wyłącza wypełnianie
nh |  | wyłącza automatycznie dzielenie wyrazów
nr | r n i | przypisuje wartość n do rejestru r z automatycznym dodawaniem i
ns |  | rozpoczyna tryb bez rozstawu
pl | v | ustawia długość strony na v
pn | n | ustawia numer następnej strony na n
po | h | ustawia przesunięcie strony na h
rj | n | wyrównuje do prawej następne n wierszy wyjściowych*
rm | m | usuwa makro, łańcuch lub żądanie m
rn | m n | zmienia nazwę makra, łańcucha lub żądania m na n
rr | r | usuwa rejestr r
rs |  | wznawia rozstaw (kończy tryb bez rozstawu)
rt | v | wraca do pionowej pozycji oznaczonej przez mk lub v
so | f | dołącza (interpoluje) plik wejściowy f
sp | n | wstawia n wierszy odstępu pionowego
ta | ... | ustawia zatrzymania tabulacji
tc | c | ustawia glif powtarzania tabulacji na c
ti | h | ustawia tymczasowe wcięcie (tylko następnego wiersza) na h
tl | ... | wypisuje trzyczęściowy tytuł
tr | ... | tłumaczy znaki
ul | n | podkreśla następnych n wierszy wyjściowych

Z wyłączeniem stron tytułowych (tworzonych przez wywołanie tp), me powstrzymuje wypisywanie odstępu pionowego u góry stron (po wypisaniu ewentualnego nagłówka stron); dlatego żądanie sp tu nie zadziała. Można w zamian wywołać bl lub ująć oczekiwane żądanie spacjowanie w przekierowaniu (diversion) np. wywołując (b i )b. me przechwytuje również żądanie ll; więcej szczegółów w „me Reference Manual”.

  Przestrzenie nazw
Obiekty w me korzystają ze ścisłej konwencji nazewniczej. Aby uniknąć konfliktów, każdy zdefiniowany przez użytkownika rejestr, łańcuch lub makro powinno być pojedynczą cyfrą lub wielką literą, a każda dłuższa sekwencja liter i cyfr musi zawierać przynajmniej jedną wielką literą. (Ze względu na przenośność pomiędzy BSD i groff me, należy ograniczyć nazwy do dwóch znaków i unikać nazwy [ (lewy nawias kwadratowy)). Nie powinno się również zmieniać przeznaczenia nazw użytych w preprocesorach.

  Makra
$0 | uchwyt nagłówka występujący po sekcji
$1 | uchwyt poziomu 1 występujący przed sekcją
$2 | uchwyt poziomu 2 występujący przed sekcją
$3 | uchwyt poziomu 3 występujący przed sekcją
$4 | uchwyt poziomu 4 występujący przed sekcją
$5 | uchwyt poziomu 5 występujący przed sekcją
$6 | uchwyt poziomu 6 występujący przed sekcją
$C | uchwyt tytułu występujący po rozdziale
$H | uchwyt nagłówka strony/kolumny
$c | wypisuje numer rozdziału i tytuł
$f | wypisuje stopkę
$h | wypisuje nagłówek
$p | wypisuje nagłówek sekcji
$s | wypisuje separator przestrzeni stopki
(b | rozpoczyna blok
(c | rozpoczyna blok wyśrodkowany
(d | rozpoczyna opóźniony tekst
(f | rozpoczyna stopkę
(l | rozpoczyna listę
(q | rozpoczyna długie cytowanie
(x | rozpoczyna element indeksu
(z | rozpoczyna wysuniętą klauzulę
)b | kończy blok
)c | kończy wyśrodkowany blok
)d | kończy opóźniony tekst
)f | kończy stopkę
)l | kończy listę
)q | kończy długie cytowanie
)x | kończy element indeksu
)z | kończy wysuniętą klauzulę
++ | ustawia typ segmentu dokumentu
+c | rozpoczyna rozdział
1c | kończy układ wielokolumnowy
2c | rozpoczyna układ wielokolumnowy
EN | kończy cytowanie eqn
EQ | rozpoczyna cytowanie eqn
GE | kończy obrazek grn z pozycją rysowania na spodzie
GF | kończy obrazek grn z pozycją rysowania na wierzchu
GS | rozpoczyna obrazek grn
IE | kończy obrazek ideal z pozycją rysowania na spodzie
IF | kończy obrazek ideal z pozycją rysowania na wierzchu
IS | rozpoczyna obrazek ideal
PE | kończy obrazek pic z pozycją rysowania na spodzie
PF | kończy obrazek pic z pozycją rysowania na wierzchu
PS | rozpoczyna obrazek pic
TE | kończy tabelę tbl
TH | kończy nagłówek wielostronicowej tabeli tbl
TS | rozpoczyna tabelę tbl
b | pogrubia argument
ba | ustawia podstawowe wcięcie
bc | rozpoczyna nową kolumnę
bi | ustawia pogrubienie i kursywę na argumencie
bx | rysuje ramkę wokół argumentu
ef | ustawia stopkę parzystych stron
eh | ustawia nagłówek parzystych stron
ep | kończy stronę
fo | ustawia stopkę
he | ustawia nagłówek
hl | wstawia poziomą linię
hx | wyłącza nagłówki/stopki na następnej stronie
i | ustawia kursywę na argumencie
ip | rozpoczyna wcięty akapit
ld | resetuje lokalizację i rejestry dat i łańcuchy*
ll | ustawia długość wiersza
lp | rozpoczyna akapit w pełni wyrównany do lewej
np | rozpoczyna akapit numerowany
of | ustawia stopkę stron nieparzystych
oh | ustawia nagłówek stron nieparzystych
pd | wypisuje opóźniony tekst
pp | rozpoczyna akapit z wciętym pierwszym wierszem
q | cytuje argument
r | ustawia argument na czcionkę roman
re | resetuje miejsca zatrzymań tabulacji
sh | rozpoczyna sekcję numerowaną
sm | ustawia argument na mniejszą wielkość
sx | zmienia głębokość sekcji
sz | ustawia rozmiar typu i pionowy rozstaw
tp | rozpoczyna stronę tytułową
u | podkreśla argument
uh | rozpoczyna sekcję nienumerowaną
xl | ustawia długość wiersza (lokalnie)
xp | wypisuje spis treści

Niektóre makra są zapewniane ze względu na „dawną” kompatybilność z roff(1) Podręcznik „me Reference Manual” opisuje alternatywy dla współczesnych dokumentów.

ar | używa liczb arabskich do numerowania stron
bl | wstawia spację (nawet na górze strony; zob. sp)
ix | ustawia wcięcie bez przełamania
m1 | ustawia odstęp górną krawędzią strony a nagłówkiem
m2 | ustawia odstęp między nagłówkiem a tekstem
m3 | ustawia odstęp między tekstem a stopką
m4 | ustawia odstęp między stopką a dolną krawędzią strony
n1 | rozpoczyna numerowanie wierszy wyjściowych
n2 | kończy lub zmienia numerowanie wierszy wyjściowych
pa | rozpoczyna stronę
ro | używa liczb rzymskich do numerowania stron
sk | pomija następną stronę

  Rejestry
$0 | głębokość sekcji
$1 | pierwsza składowa numeru sekcji
$2 | druga składowa numeru sekcji
$3 | trzecia składowa numeru sekcji
$4 | czwarta składowa numeru sekcji
$5 | piąta składowa numeru sekcji
$6 | szósta składowa numeru sekcji
$c | numer bieżącej kolumny
$d | numer opóźnionego tekstu
$f | numer stopki
$i | podstawowe wcięcie akapitu
$l | szerokość kolumny
$m | liczba dostępnych kolumn
$p | numer numerowanego akapitu
$s | rozstaw kolumny (wcięcie)
bi | wyświetla wcięcie (bloku)
bm | odstęp pomiędzy przestrzenią tekstu a dolną krawędzią strony
bs | wyświetla spację poprzedzającą/następującą po (bloku)
bt | próg bloku dla klauzul
ch | numer bieżącego rozdziału
df | wyświetlany font
dv | pionowe odstępy wyświetlanego tekstu (jako procent)*
es | spacja przed/po równaniem
ff | font stopki
fi | wcięcie stopki (tylko pierwszy wiersz)
fm | margines stopki
fp | rozmiar fontu stopki w punktach
fs | przestrzeń przed stopką
fu | prawe wcięcie stopki
hm | margines nagłówka
ii | wcięcie wciętego akapitu
no | przesunięcie numerowania wierszy*
pf | font akapitu
pi | wcięcie akapitu
po | przesunięcie strony
pp | rozmiar fontu akapitu w punktach
ps | przestrzeń przed akapitem
qi | lewe/prawe wcięcie długiego cytowania
qp | rozmiar fontu długiego cytowania w punktach
qs | spacja przed/po długim cytowaniem
sf | font tytułu sekcji
si | wcięcie sekcji według poziomu głębokości
so | dodatkowe przesunięcie tytułu sekcji
sp | rozmiar fontu tytułu sekcji w punktach
ss | przestrzeń przed sekcją
sx | zwiększenie wysokości wiersza z indeksem górnym/dolnym*
tf | font tytułu
tm | odległość pomiędzy górną krawędzią strony a przestrzenią tekstu
tp | rozmiar fontu tytułu w punktach
tv | pionowe odstępy tekstu (jako procent)*
xs | przestrzeń przed pozycją indeksu
xu | prawe wcięcie indeksu
y2 | rok w stuleciu*
y4 | rok*
yr | rok minus 1900
zs | przestrzeń przed/po ruchomą klauzulą

  Łańcuchy znakowe
# | znacznik opóźnionego tekstu
$n | łączony numer sekcji
* | znacznik stopki
- | pauza (o długości m)
< | początek indeksu dolnego
> | koniec indeksu dolnego
dw | nazwa dnia tygodnia
lq | lewy znak podwójnego cudzysłowu (górnego)
mo | nazwa miesiąca
rq | prawy znak podwójnego cudzysłowu (górnego)
td | data
wa | wyrażenie dla dodatku („appendix”) używane przez .$c*
wc | wyrażenie dla rozdziału („chapter”) używane przez .$c*
{ | początek indeksu górnego
} | koniec indeksu górnego

Pliki

/usr/share/groff/1.23.0/tmac/e.tmac
    implementuje pakiet

/usr/share/groff/1.23.0/tmac/refer-me.tmac
    implementuje obsługę refer(1) dla me.

/usr/share/groff/1.23.0/tmac/me.tmac
    opakowanie pozwalające załadować pakiet za pomocą „groff -m me”.

Uwagi
Wczesne pakiety makra roff często ograniczały swe nazwa do pojedynczej litery, które następowały po literze znacznika formatowania m, co dawało mm, ms, mv, mn itd. The „e” w „me” pochodzi od „Erica P. Allmana”, który napisał pakiet makr i pierwotną dokumentację techniczną go opisującą w trakcie studiów I stopnia na Uniwersytecie Kalifornijskim.

Zobacz także
Dostępne są dwa podręczniki — w postaci źródłowej i renderowanej. W niniejszym systemie mogą być one skompresowane i/lub dostępne w dodatkowych formatach.

/usr/share/doc/groff-base/meintro.me
/usr/share/doc/groff-base/meintro.ps
    to „Writing Papers with Groff Using -me” autorstwa Erica P. Allmana, zaadaptowane do groffa przez Jamesa Clarka.

/usr/share/doc/groff-base/meref.me
/usr/share/doc/groff-base/meref.ps
    to „me Reference Manual” autorstwa Erica P. Allmana, zaadaptowane do groffa przez Jamesa Clarka i G. Brandena Robinsona.

Groff: The GNU Implementation of troff autorstwa Trenta A. Fishera i Wernera Lemberga, będący głównym podręcznikiem groff. Można jest przeglądać interaktywnie za pomocą polecenia „info groff”.

Odnośnie preprocesorów obsługiwanych przez me, zob. eqn(1), grn(1), pic(1), refer(1) i tbl(1).

groff(1), troff(1), groff(7)

TŁUMACZENIE
Tłumaczenie niniejszej strony podręcznika: Marcin Mazurek <mazek@capella.ae.poznan.pl>, Michał Kułach <michal.kulach@gmail.com> i Robert Luberda <robert@debian.org>

Niniejsze tłumaczenie jest wolną dokumentacją. Bliższe informacje o warunkach licencji można uzyskać zapoznając się z GNU General Public License w wersji 3 (https://www.gnu.org/licenses/gpl-3.0.html) lub nowszej. Nie przyjmuje się ŻADNEJ ODPOWIEDZIALNOŚCI.

Błędy w tłumaczeniu strony podręcznika prosimy zgłaszać na adres listy dyskusyjnej manpages-pl-list@lists.sourceforge.net.