groff_me(7) Miscellaneous Information Manual groff_me(7) Nazwa groff_me - pakiet makr ,,me" do formatowania dokumentow roff Skladnia groff -me [opcja ...] [plik ...] groff -m me [opcja ...] [plik ...] Opis Implementacja GNU pakietu makr me jest czescia systemu formatowania dokumentow groff. Pakiet definicji makr me do jezyka roff zapewnia dogodne funkcje do przygotowywania dokumentow technicznych w roznych formatach. Niniejsza wersja powstala w oparciu o me dostarczane z 4.4BSD i moze byc uzywana z programem formatujacym GNU troff oraz tymi, ktore wywodza sie z AT&T troff. Niektore zadania formatowania wplywaja w sposob nieprzewidywalny na wyglad strony, gdy sa uzywane lacznie z niniejszym pakietem, jednak ponizsze moga byc uzywane bez problemu po wystapieniu pierwszego wywolania makra akapitowego, takiego jak lp lub pp. Niektore argumenty sa opcjonalne; w podreczniku groff(7) zawarto wiecej informacji, szczegolnie na temat zadan, ktorych liste argumentow 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 dolacza makro m do momentu wywolania e as s t dolacza reszte wiersza t do lancucha s bp n rozpoczyna nowa strone o numerze n br przelamuje w tym miejscu wiersz wyjsciowy ce n srodkuje nastepne n wierszy wyjsciowych cp n wl./wyl. tryb kompatybilnosci AT&T troff* de m e definiuje makro m do momentu wywolania e do t interpretuje wejscie t z wylaczonym trybem kompatybilnosci* ds s t definiuje reszte wiersza t jako lancuch s el t interpretuje t jesli towarzyszace ie jest falszywe fc c d ustawia rozgranicznik pol na c i glif wyrownania na d fi wlacza wypelnianie hc c ustawia znak dzielenia wyrazow na c hy m ustawia auomatyczny tryb dzielenia na m ie p t jak if, lecz wlacza interpretacje pozniejszych el if p t jesli warunek p, to interpretuje reszte wiersza t in h ustawia wciecie 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 odleglosci h mk r oznacza pionowa pozycje w rejestrze r na wylacza dostosowywanie tekstu ne v wymaga pionowej przestrzeni w odleglosci v nf wylacza wypelnianie nh wylacza automatycznie dzielenie wyrazow nr r n i przypisuje wartosc n do rejestru r z automatycznym dodawaniem i ns rozpoczyna tryb bez rozstawu pl v ustawia dlugosc strony na v pn n ustawia numer nastepnej strony na n po h ustawia przesuniecie strony na h rj n wyrownuje do prawej nastepne n wierszy wyjsciowych* rm m usuwa makro, lancuch lub zadanie m rn m n zmienia nazwe makra, lancucha lub zadania m na n rr r usuwa rejestr r rs wznawia rozstaw (konczy tryb bez rozstawu) rt v wraca do pionowej pozycji oznaczonej przez mk lub v so f dolacza (interpoluje) plik wejsciowy f sp n wstawia n wierszy odstepu pionowego ta ... ustawia zatrzymania tabulacji tc c ustawia glif powtarzania tabulacji na c ti h ustawia tymczasowe wciecie (tylko nastepnego wiersza) na h tl ... wypisuje trzyczesciowy tytul tr ... tlumaczy znaki ul n podkresla nastepnych n wierszy wyjsciowych Z wylaczeniem stron tytulowych (tworzonych przez wywolanie tp), me powstrzymuje wypisywanie odstepu pionowego u gory stron (po wypisaniu ewentualnego naglowka stron); dlatego zadanie sp tu nie zadziala. Mozna w zamian wywolac bl lub ujac oczekiwane zadanie spacjowanie w przekierowaniu (diversion) np. wywolujac (b i )b. me przechwytuje rowniez zadanie ll; wiecej szczegolow w ,,me Reference Manual". Przestrzenie nazw Obiekty w me korzystaja ze scislej konwencji nazewniczej. Aby uniknac konfliktow, kazdy zdefiniowany przez uzytkownika rejestr, lancuch lub makro powinno byc pojedyncza cyfra lub wielka litera, a kazda dluzsza sekwencja liter i cyfr musi zawierac przynajmniej jedna wielka litera. (Ze wzgledu na przenosnosc pomiedzy BSD i groff me, nalezy ograniczyc nazwy do dwoch znakow i unikac nazwy [ (lewy nawias kwadratowy)). Nie powinno sie rowniez zmieniac przeznaczenia nazw uzytych w preprocesorach. Makra $0 uchwyt naglowka wystepujacy po sekcji $1 uchwyt poziomu 1 wystepujacy przed sekcja $2 uchwyt poziomu 2 wystepujacy przed sekcja $3 uchwyt poziomu 3 wystepujacy przed sekcja $4 uchwyt poziomu 4 wystepujacy przed sekcja $5 uchwyt poziomu 5 wystepujacy przed sekcja $6 uchwyt poziomu 6 wystepujacy przed sekcja $C uchwyt tytulu wystepujacy po rozdziale $H uchwyt naglowka strony/kolumny $c wypisuje numer rozdzialu i tytul $f wypisuje stopke $h wypisuje naglowek $p wypisuje naglowek sekcji $s wypisuje separator przestrzeni stopki (b rozpoczyna blok (c rozpoczyna blok wysrodkowany (d rozpoczyna opozniony tekst (f rozpoczyna stopke (l rozpoczyna liste (q rozpoczyna dlugie cytowanie (x rozpoczyna element indeksu (z rozpoczyna wysunieta klauzule )b konczy blok )c konczy wysrodkowany blok )d konczy opozniony tekst )f konczy stopke )l konczy liste )q konczy dlugie cytowanie )x konczy element indeksu )z konczy wysunieta klauzule ++ ustawia typ segmentu dokumentu +c rozpoczyna rozdzial 1c konczy uklad wielokolumnowy 2c rozpoczyna uklad wielokolumnowy EN konczy cytowanie eqn EQ rozpoczyna cytowanie eqn GE konczy obrazek grn z pozycja rysowania na spodzie GF konczy obrazek grn z pozycja rysowania na wierzchu GS rozpoczyna obrazek grn IE konczy obrazek ideal z pozycja rysowania na spodzie IF konczy obrazek ideal z pozycja rysowania na wierzchu IS rozpoczyna obrazek ideal PE konczy obrazek pic z pozycja rysowania na spodzie PF konczy obrazek pic z pozycja rysowania na wierzchu PS rozpoczyna obrazek pic TE konczy tabele tbl TH konczy naglowek wielostronicowej tabeli tbl TS rozpoczyna tabele tbl b pogrubia argument ba ustawia podstawowe wciecie bc rozpoczyna nowa kolumne bi ustawia pogrubienie i kursywe na argumencie bx rysuje ramke wokol argumentu ef ustawia stopke parzystych stron eh ustawia naglowek parzystych stron ep konczy strone fo ustawia stopke he ustawia naglowek hl wstawia pozioma linie hx wylacza naglowki/stopki na nastepnej stronie i ustawia kursywe na argumencie ip rozpoczyna wciety akapit ld resetuje lokalizacje i rejestry dat i lancuchy* ll ustawia dlugosc wiersza lp rozpoczyna akapit w pelni wyrownany do lewej np rozpoczyna akapit numerowany of ustawia stopke stron nieparzystych oh ustawia naglowek stron nieparzystych pd wypisuje opozniony tekst pp rozpoczyna akapit z wcietym pierwszym wierszem q cytuje argument r ustawia argument na czcionke roman re resetuje miejsca zatrzyman tabulacji sh rozpoczyna sekcje numerowana sm ustawia argument na mniejsza wielkosc sx zmienia glebokosc sekcji sz ustawia rozmiar typu i pionowy rozstaw tp rozpoczyna strone tytulowa u podkresla argument uh rozpoczyna sekcje nienumerowana xl ustawia dlugosc wiersza (lokalnie) xp wypisuje spis tresci Niektore makra sa zapewniane ze wzgledu na ,,dawna" kompatybilnosc z roff(1) Podrecznik ,,me Reference Manual" opisuje alternatywy dla wspolczesnych dokumentow. ar uzywa liczb arabskich do numerowania stron bl wstawia spacje (nawet na gorze strony; zob. sp) ix ustawia wciecie bez przelamania m1 ustawia odstep gorna krawedzia strony a naglowkiem m2 ustawia odstep miedzy naglowkiem a tekstem m3 ustawia odstep miedzy tekstem a stopka m4 ustawia odstep miedzy stopka a dolna krawedzia strony n1 rozpoczyna numerowanie wierszy wyjsciowych n2 konczy lub zmienia numerowanie wierszy wyjsciowych pa rozpoczyna strone ro uzywa liczb rzymskich do numerowania stron sk pomija nastepna strone Rejestry $0 glebokosc sekcji $1 pierwsza skladowa numeru sekcji $2 druga skladowa numeru sekcji $3 trzecia skladowa numeru sekcji $4 czwarta skladowa numeru sekcji $5 piata skladowa numeru sekcji $6 szosta skladowa numeru sekcji $c numer biezacej kolumny $d numer opoznionego tekstu $f numer stopki $i podstawowe wciecie akapitu $l szerokosc kolumny $m liczba dostepnych kolumn $p numer numerowanego akapitu $s rozstaw kolumny (wciecie) bi wyswietla wciecie (bloku) bm odstep pomiedzy przestrzenia tekstu a dolna krawedzia strony bs wyswietla spacje poprzedzajaca/nastepujaca po (bloku) bt prog bloku dla klauzul ch numer biezacego rozdzialu df wyswietlany font dv pionowe odstepy wyswietlanego tekstu (jako procent)* es spacja przed/po rownaniem ff font stopki fi wciecie stopki (tylko pierwszy wiersz) fm margines stopki fp rozmiar fontu stopki w punktach fs przestrzen przed stopka fu prawe wciecie stopki hm margines naglowka ii wciecie wcietego akapitu no przesuniecie numerowania wierszy* pf font akapitu pi wciecie akapitu po przesuniecie strony pp rozmiar fontu akapitu w punktach ps przestrzen przed akapitem qi lewe/prawe wciecie dlugiego cytowania qp rozmiar fontu dlugiego cytowania w punktach qs spacja przed/po dlugim cytowaniem sf font tytulu sekcji si wciecie sekcji wedlug poziomu glebokosci so dodatkowe przesuniecie tytulu sekcji sp rozmiar fontu tytulu sekcji w punktach ss przestrzen przed sekcja sx zwiekszenie wysokosci wiersza z indeksem gornym/dolnym* tf font tytulu tm odleglosc pomiedzy gorna krawedzia strony a przestrzenia tekstu tp rozmiar fontu tytulu w punktach tv pionowe odstepy tekstu (jako procent)* xs przestrzen przed pozycja indeksu xu prawe wciecie indeksu y2 rok w stuleciu* y4 rok* yr rok minus 1900 zs przestrzen przed/po ruchoma klauzula Lancuchy znakowe # znacznik opoznionego tekstu $n laczony numer sekcji * znacznik stopki - pauza (o dlugosci m) < poczatek indeksu dolnego > koniec indeksu dolnego dw nazwa dnia tygodnia lq lewy znak podwojnego cudzyslowu (gornego) mo nazwa miesiaca rq prawy znak podwojnego cudzyslowu (gornego) td data wa wyrazenie dla dodatku (,,appendix") uzywane przez .$c* wc wyrazenie dla rozdzialu (,,chapter") uzywane przez .$c* { poczatek indeksu gornego } koniec indeksu gornego Pliki /usr/share/groff/1.23.0/tmac/e.tmac implementuje pakiet /usr/share/groff/1.23.0/tmac/refer-me.tmac implementuje obsluge refer(1) dla me. /usr/share/groff/1.23.0/tmac/me.tmac opakowanie pozwalajace zaladowac pakiet za pomoca ,,groff -m me". Uwagi Wczesne pakiety makra roff czesto ograniczaly swe nazwa do pojedynczej litery, ktore nastepowaly po literze znacznika formatowania m, co dawalo mm, ms, mv, mn itd. The ,,e" w ,,me" pochodzi od ,,Erica P. Allmana", ktory napisal pakiet makr i pierwotna dokumentacje techniczna go opisujaca w trakcie studiow I stopnia na Uniwersytecie Kalifornijskim. Zobacz takze Dostepne sa dwa podreczniki -- w postaci zrodlowej i renderowanej. W niniejszym systemie moga byc one skompresowane i/lub dostepne w dodatkowych formatach. /usr/share/doc/groff-1.23.0/meintro.me /usr/share/doc/groff-1.23.0/meintro.ps to ,,Writing Papers with Groff Using -me" autorstwa Erica P. Allmana, zaadaptowane do groffa przez Jamesa Clarka. /usr/share/doc/groff-1.23.0/meref.me /usr/share/doc/groff-1.23.0/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, bedacy glownym podrecznikiem groff. Mozna jest przegladac interaktywnie za pomoca polecenia ,,info groff". Odnosnie preprocesorow obslugiwanych przez me, zob. eqn(1), grn(1), pic(1), refer(1) i tbl(1). groff(1), troff(1), groff(7) TLUMACZENIE Tlumaczenie niniejszej strony podrecznika: Marcin Mazurek , Michal Kulach i Robert Luberda Niniejsze tlumaczenie jest wolna dokumentacja. Blizsze informacje o warunkach licencji mozna uzyskac zapoznajac sie z GNU General Public License w wersji 3 lub nowszej. Nie przyjmuje sie ZADNEJ ODPOWIEDZIALNOSCI. Bledy w tlumaczeniu strony podrecznika prosimy zglaszac na adres listy dyskusyjnej . groff 1.23.0 28 sierpnia 2024 r. groff_me(7)