Provided by:
manpages-pl_20060617-3_all 
NAZWA
RosettaMan, rman - odwrotna kompilacja stron man z postaci
sformatowanej do ronych formatow rodlowych
SK/LADNIA
rman [ opcje ] [ plik ]
OPIS
RosettaMan przyjmuje strony man podrcznika systemowego z wikszoci
popularnych odmian Unixa i przeksztalca je na jeden z wielu formatow
tekstu rodlowego. Uprzednio RosettaMan wymagal, by przed przetwarzaniem
strony zostaly sformatowane przez nroff. Od wersji 3.0 woli r'od/la
[tn]roff i zwykle daje wyniki, ktore s jeszcze lepsze. Za przetwarzanie
rodlowej postaci stron man jest jedyn metod tlumaczenia tabel.
W analizie rodel [tn]roff powinno si zaimplementowa dowolnie duy
podzbior [tn]roff, czego nie zrobilem i nie zrobi, zatem wyniki mog by
do odlegle. Zaimplementowalem jednak znaczcy podzbior uywanych w
stronach man, lcznie z tbl (ale nie eqn), testami if, definicjami makr
ogolnych. Wyniki zatem zwykle wygldaj doskonale. Jeli nie, sformatuj
stron przy pomocy nroff przed przeslaniem jej do RosettaMan. Jeli
jednak RosettaMan nie rozpoznaje wanego makra uywanego przez liczn klas
stron man, to wylij mi e-mail ze rodlem i stron sformatowan nroff-em a
zobacz, co da si zrobi. Uruchamiajc RosettaMan ze rodlem strony
zawierajcym makro .so (wlczanie innych albo przekierowanie do innego
rodla [tn]roff), powiniene by w katalogu nadrzdnym danej strony, gdy
strony s zapisywane przy takim wlanie zaloeniu. Na przyklad, jeli
przeksztalcasz /usr/man/man1/ls.1, to zmie uprzednio katalog na
/usr/man.
RosettaMan przyjmuje strony man z: SunOS, Sun Solaris, Hewlett-Packard
HP-UX, AT&T System V, OSF/1 aka Digital UNIX, DEC Ultrix, SGI IRIX,
Linux, FreeBSD, SCO. Przetwarzanie postaci rodlowej dziala dla: SunOS,
Sun Solaris, Hewlett-Packard HP-UX, AT&T System V, OSF/1 aka Digital
UNIX, DEC Ultrix. Potrafi tworzy drukowalne tylko-ASCII (usunite znaki
sterujce), tylko-naglowki-sekcji, Tk, TkMan, [tn]roff (tradycyjne rodla
stron man), SGML, HTML, MIME, LaTeX, LaTeX2e, RTF, Perl 5 POD.
Modularna budowa umoliwia latwe dodawanie dodatkowych formatow
wyjciowych.
Najnowsza wersja RosettaMan dostpna jest zawsze z
ftp://ftp.cs.berkeley.edu/ucb/people/phelps/tcltk/rman.tar.Z.
OPCJE
Ponisze dwie opcje nie powinny by uywane z innymi. Powoduj zakoczenie
pracy przez RosettaMan bez przetwarzania wejcia.
-h, --help
Poka list opcji wiersza polece i zakocz prac.
-v, --version
Poka numer wersji i zakocz prac.
Filtr powiniene poda jako pierwszy, gdy ta ustawia r'one inne parametry.
Pozosta/le opcje podaj po nim.
-f, --filter [ASCII|roff|TkMan|Tk|Sections|HTML|SGML|MIME|
LaTeX|LaTeX2e|RTF|POD]
Ustaw filtr wyjcia. Domylnie jest to ASCII.
-S, --source
RosettaMan usiluje samoczynnie okreli czy dane wejciowe s w
postaci rodlowej czy w sformatowanej; poslu si t opcj do
zadeklarowania wejcia w postaci rodlowej.
-F, --format, --formatted
RosettaMan usiluje samoczynnie okreli czy dane wejciowe s w
postaci rodlowej czy w sformatowanej; poslu si t opcj do
zadeklarowania wejcia w postaci sformatowanej.
-l, --title /lacuch-printf
W trybie HTML ustawia tytul (znacznik <TITLE>) stron man,
pobierajc parametry takie jak opcja -r.
-r, --reference, --manref /lacuch-printf
W trybach HTML i SGML okrela posta URL, przy pomocy ktorej
pozyskiwa inne strony man. Lacuch moe uywa dwu podanych
parametrow: nazwy strony man i jej sekcji. (Zobacz sekcja
Przyklady.) Jeeli lacuch jest pusty (tak jak ustawiony z
powloki przez "-r ''"), ma warto `-' lub `off', to odnoniki
wystpujce na stronie man nie bd wymienione na znaczniki HREF,
lecz tylko zapisane czcionk pochyl (italic). Jeli Twoj printf
obsluguje okrelanie pozycji XPG3, to moe to by do elastyczne.
-V, --volumes <lista rozdzielana drukropkami>
Ustawia list dozwolonych wolumenow (czci) sprawdzanych podczas
wyszukiwania powiza z innymi stronami man. Domylnie jest to
1:2:3:4:5:6:7:8:9:o:l:n:p (nazwy czci mog by wieloznakowe).
Jeeli po lacuchu zawierajcym znaki rone od bialych znakow
wystpuje bezporednio lewy nawias, nastpnie jedna z nazw
wolumenow, za koczy si opcjonalnymi innymi znakami i prawym
nawiasem -- to taki lacuch zglaszany jest jako odnonik do innej
strony man. Jeli w uytej opcji -V lacuch zaczyna si od znaku
rownoci, to nie s dozwolone adne dodatkowe znaki pomidzy
dopasowan nazw wolumenu a prawym nawiasem. (Opcja ta jest
potrzebna dla SCO UNIX.)
Ponisze opcje maj zastosowanie tylko wtedy, gdy jako wejcie podano
strony sformatowane. Nie maj zastosowania lub nie zawsze s obslugiwane
poprawnie dla stron w postaci rodlowej.
-b, --subsections
Oprocz tytulow sekcji probuj rozpoznawa tytuly podsekcji. W
niektorych odmianach moe to powodowa klopoty.
-K, --nobreak
Wska, e strony man nie posiadaj lamania strony, zatem nie szukaj
w pobliu stopek i naglowkow. (Starsze makra nroff -man zawsze
wstawialy lamanie strony, ale ostatnio niektorzy dostawcy
zauwayli, e wydruki robione s poprzez troff, podczas gdy nroff
-man sluy do formatowania stron do czytania na ekranie, a zatem
usunli lamanie stron.) RosettaMan zwykle obsluguje t sytuacj
poprawnie, nawet bez tej flagi.
-k, --keep
Pozostaw naglowki i stopki jako kanoniczny raport na kocu
strony.
-c, --changeleft
Przesu changebars, takie jak znajdowane w stronach man Tcl/Tk,
do lewej.
-n, --name nazwa
Ustaw nazw strony man (uywane w formacie roff). Jeli nazw pliku
podano w postaci "nazwa.sekcja", to nazwa i sekcja s okrelane
automatycznie. Jeli strona jest analizowana ze rodla [tn]roff i
posiada wiersz .TH, to s one wyluskiwane z tego wiersza.
-p, --paragraph
Przelcznik trybu akapitow. Zastosowany filtr okrela, czy wiersze
powinny by lamane, tak jak zrobilby to nroff, czy te plyn razem
tworzc akapity. Glownie do uytku wewntrznego.
-s, section #
Ustaw numer wolumenu (czci, sekcji) strony man (uywane w
formacie roff).
-t, --tabstops #
Niektore zestawy makr uywaj, gdzie to moliwe, tabulatorow
zamiast spacji w celu zmniejszenia liczby uywanych znakow. Ta
opcja ustawia pozycje tabulacji co # kolumn. Domylnie co 8.
UWAGI NT.TYP'OW FILTR'OW
ROFF
W niektorych odmianach Unixa strony man dostarczane s bez rodel
[tn]roff, czynic z Twojej drukarki laserowej niewiele wicej ni laserowo
napdzan drukark rozetkow. Ten filtr probuje odtworzy pierwotne
dyrektywy [tn]roff, ktore nastpnie mog by skompilowane przez [tn]roff.
TkMan
TkMan, hipertekstowa przegldarka stron man, posluguje si programem
RosettaMan do pokazywania stron man bez, zwykle zbdnych, naglowkow i
stopek na kadej stronie. Zbiera rownie naglowki sekcji (i opcjonalnie
podsekcji), by z rozwijalnego menu zapewni bezporedni dostp do
odpowiednich czci strony. TkMan oraz Tcl/Tk, narzdzie, w ktorym jest on
napisany, dostpne s przez anonimowe ftp z ftp://ftp.smli.com/pub/tcl/
Tk
Opcja ta generuje tekst w postaci serii list Tcl skladajcych si z par
tekst-znaczniki, gdzie nazwy znacznikow z grubsza odpowiadaj uywanym w
HTML. Wynik taki moe by wstawiony do tekstowego widgetu Tk przez
wykonanie eval <textwidget> insert end <text>. Format ten powinien by
stosunkowo latwy do analizowania przez inne programy, ktore potrzebuj
zarowno tekstu jak i znacznikow. Zobacz te ASCII.
ASCII
Przy wydruku na drukarce wierszowej strony man usiluj uzyska specjalne
efekty tekstu przez nadpisywanie znakow ponownie tymi samymi znakami
(by otrzyma pogrubienie) czy znakami dolnej kreski (podkrelenia) (by
otrzyma pokrelenie znaku). Inne oprogramowanie przetwarzajce teksty,
jak edytory, wyszukiwarki czy programy indeksujce musi temu
przeciwdziala. Filtr ASCII pozbywa si dodatkow z opisanego sposobu
formatowania. Przepuszczenie przez potok wyjcia z nroff do col -b
rownie usuwa takie formatowanie, ale pozostawia brzydkie naglowki i
stopki stron. Zobacz take Tk.
Sections
Zrzuca tytuly sekcji i (opcjonalnie) podsekcji. Moe by przydatne dla
innego programu przetwarzajcego strony man.
HTML
Przy prostym rozszerzeniu serwera HTTP dla Mosaic czy innej przegldarki
WWW [np.Netscape], RosettaMan moe w locie tworzy wysokiej jakoci kod
HTML. Kilka takich rozszerze i wskazanie na inne dolczone s w katalogu
contrib programu RosettaMan.
SGML
Ten filtr zmierza do Docbook DTD, ale mam nadziej, e kto faktycznie
zainteresowany t opcj wygladzi tworzone znaczniki. Sprobuj, a
zobaczysz, jak blisko s one obecnie.
MIME
MIME (Multipurpose Internet Mail Extensions), jak zdefiniowano w RFC
1563, odpowiednie do spoycia przez programy pocztowe obslugujce MIME
albo jako wzbogacone dokumenty Emacsa (>=19.26).
LaTeX i LaTeX2e
Czemu nie?
RTF
Uyj wyniku na Mac-u, NeXT lub czymkolwiek. Moe we losowe strony man i
lepiej polcz je z systemem dokumentacji NeXTa. Moe NeXT ma swoje wlasne
makra stron man, ktore to robi.
PostScript i FrameMaker
W celu uzyskania PostScriptu uyj groff lub psroff. By utworzy MIF dla
FrameMakera poslu si jego wbudowanym filtrem. W obu przypadkach
potrzebujesz rodla [tn]roff, wic jeli dysponujesz wylcznie sformatowan
wersj strony man, uyj najpierw filtru roff z RosettaMan.
PRZYK/LADY
Konwersja sformatowanej strony podrcznika man o nazwie ls.1 na powrot
do postaci rodlowej [tn]roff:
rman -f roff /usr/local/man/cat1/ls.1 > /usr/local/man/man1/ls.1
W celu zaoszczdzenia miejsca dlugie strony man s czsto kompresowane.
Kompresja jest szczegolnie efektywna dla stron sformatowanych, gdy
zawieraj wiele spacji. Poniewa jest to dluga strona, prawdopodobnie
posiada podsekcje, ktore probujemy wydzieli (niektore zestawy makr nie
wyroniaj podsekcji wystarczajco dobrze, by RosettaMan je wykryl).
Zamiemy j na format LaTeX-u:
pcat /usr/catman/a_man/cat1/automount.z | rman -b -n automount -s 1 -f
latex > automount.man
Albo te:
man 1 automount | rman -b -n automount -s 1 -f latex > automount.man
Dla uytkownikow HTML/Mosaic [czy Netscape] RosettaMan moe, bez zmiany
kodu rodlowego, utworzy odnoniki (links) HTML do innych stron man w
formacie HTML albo utworzonych wczeniej albo w locie. Zalomy najpierw,
e wstpnie stworzone wersje HTML stron man umieszczane bd w
/usr/man/html. Utworzmy je jedna po drugiej w nastpujcy sposob:
rman -f html -r 'http:/usr/man/html/%s.%s.html' /usr/man/cat1/ls.1 >
/usr/man/html/ls.1.html
Jeeli rozszerzyle swego klienta HTML tak, by tworzyl kod HTML w locie,
to powiniene posluy si czym takim
rman -f html -r 'http:~/bin/man2html?%s:%s' /usr/man/cat1/ls.1
przy biecym tworzeniu wersji HTML stron man.
B/LDY/NIEZGODNOCI
RosettaMan nie we wszystkich przypadkach jest doskonaly, ale zwykle
wykonuje dobr robot, i w kadym przypadku redukuje klopot z konwersj
stron podrcznika man do niewielkich poprawek edycyjnych.
Tabele w sformatowanych stronach, szczegolnie H-P, nie s obslugiwane
najlepiej. Upewnij si, e jako parametr podajesz plik rodlowy strony, co
umoliwi rozpoznanie tabel.
Przegldarka stron man o nazwie woman wykorzystuje swoj wlasn koncepcj
formatowania stron podrcznika systemowego. Rozwizanie to moe by mylce
dla RosettaMan. Moesz omin ten problem przesylajc sformatowany tekst
strony man wprost do RosettaMan.
Format wynikowy [tn]roff posluguje si fB do wlczania pogrubienia
(Bold). Jeeli Twoj zestaw makr wymaga .B, to bdziesz musial przetworzy
wynik z RosettaMan.
ZOBACZ TAKE
tkman(1), fIxman(1), man(1), man(7) lub man(5)
w zalenoci od swojej odmiany UNIXa.
COPYRIGHT
RosettaMan
Copyright (c) 1993-1996 Thomas A. Phelps (phelps@ACM.org)
All Rights Reserved.
developed at the
University of California, Berkeley
Computer Science Division
Permission to use, copy, modify, and distribute this software and its
documentation for educational, research and non-profit purposes,
without fee, and without a written agreement is hereby granted,
provided that the above copyright notice and the following paragraph
appears in all copies.
Permission to incorporate this software into commercial products may be
obtained from the Office of Technology Licensing, 2150 Shattuck Avenue,
Suite 510, Berkeley, CA 94704.
IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
ENHANCEMENTS, OR MODIFICATIONS.
Manual page last updated on $Date: 2000/10/22 16:15:29 $
INFORMACJE O T/LUMACZENIU
Powysze tlumaczenie pochodzi z nieistniejcego ju Projektu Tlumaczenia
Manuali i moe nie by aktualne. W razie zauwaenia ronic midzy powyszym
opisem a rzeczywistym zachowaniem opisywanego programu lub funkcji,
prosimy o zapoznanie si z oryginaln (angielsk) wersj strony podrcznika.
RosettaMan(1)