table of contents
other sections
PolyglotMan(1) | General Commands Manual | PolyglotMan(1) |
NAZWA¶
PolyglotMan, rman - odwrotna kompilacja stron podręcznika z postaci sformatowanej do różnych formatów źródłowych: ASCII, roff, TkMan, Tk, Sections, HTML, SGML, MIME, LaTeX, LaTeX2e, RTF, POD.SKŁADNIA¶
rman [ opcje ] [ plik ]OPIS¶
Najbardziej aktualną dokumentację można znaleźć pod adresem http://polyglotman.sourceforge.net/rman.html PolyglotMan przyjmuje strony man podręcznika systemowego z większości popularnych odmian Uniksa i przekształca je na jeden z wielu formatów tekstu źródłowego. PolyglotMan był wcześniej znany pod nazwą RosettaMan. Program wykonywalny jest wciąż nazywa się rman z powodu skryptów, które mogą zależeć od tej nazwy; można przyjąć, że nazwa ta oznacza "reverse man" ("odwrotny man"). Poprzednio PolyglotMan wymagał, by strony przed przetwarzaniem zostały sformatowane przez nroff. Od wersji 3.0 woli źródła [tn]roff i zwykle daje wyniki, które są jeszcze lepsze. Przetwarzanie źródłowej postaci stron podręcznika jest jedyną metodą tłumaczenia tabel. Jednakże przetwarzanie źródeł nie jest tak dojrzałe jak przetwarzanie stron sformatowanych, dlatego pomocniczo zawsze można spróbować przetwarzania stron sformatowanych. W analizie źródeł [tn]roff powinno się zaimplementować dowolnie duży podzbiór [tn]roff, czego nie zrobiłem i nie zrobię, zatem wyniki mogą być czasem niepoprawne. Zaimplementowałem jednak znaczący podzbiór poleceń [tr]roff używanych w stronach man, łącznie z tbl (ale nie eqn), testami if oraz definicjami makr ogólnych. Wyniki zatem zwykle wyglądają doskonale. Jeśli nie, należy sformatować stronę przy pomocy nroff przed przesłaniem jej do PolyglotMan. Jeśli jednak PolyglotMan nie rozpoznaje ważnego makra używanego przez liczną klasę stron man, to proszę o wysłanie mi e-maila ze źródłem i stroną sformatowaną nroff-em, a zobaczę, co da się zrobić. Uruchamiając PolyglotMan ze źródłem strony zawierającym makro .so (włączanie innych stron albo przekierowanie do innego źródła [tn]roff), powinno się być w katalogu nadrzędnym danej strony, gdyż strony są zapisywane przy takim właśnie założeniu. Na przykład przed przekształceniem /usr/share/man/man1/ls.1 należy zmienić katalog na /usr/share/man. PolyglotMan przyjmuje strony podręczników z systemów: 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 źródłowej działa dla: SunOS, Sun Solaris, Hewlett-Packard HP-UX, AT&T System V, OSF/1 aka Digital UNIX, DEC Ultrix. Potrafi tworzyć strony w formatach: "tylko drukowalne ASCII" (usunięte znaki sterujące), "tylko nagłówki sekcji", Tk, TkMan, [tn]roff (tradycyjne źródła stron man), XML, HTML, MIME, LaTeX, LaTeX2e, RTF, Perl 5 POD. Modularna budowa umożliwia łatwe dodawanie dodatkowych formatów wyjściowych. Najnowsza wersja PolyglotMan dostępna jest zawsze pod adresem http://polyglotman.sourceforge.net/.OPCJE¶
Poniższe dwie opcje nie powinny być używane z innymi. Powodują zakończenie pracy przez PolyglotMan bez przetwarzania wejścia.- -h|--help
- Wyświetla listę opcji wiersza poleceń i kończy pracę.
- -v|--version
- Wyświetla numer wersji i kończy pracę.
- -f|--filter <ASCII|roff|TkMan|Tk|Sections|HTML|XML|MIME|LaTeX|LaTeX2e|RTF|POD>
- Ustawia filtr wyjścia. Domyślnie jest to ASCII.
- -S|--source
- PolyglotMan usiłuje samodzielnie określić, czy dane wejściowe są w postaci źródłowej czy w sformatowanej; opcji tej należy użyć do zadeklarowania wejścia w postaci źródłowej.
- -F|--format|--formatted
- PolyglotMan usiłuje samoczynnie określić czy dane wejściowe są w postaci źródłowej czy w sformatowanej; posłuż się tą opcją do zadeklarowania wejścia w postaci sformatowanej.
- -l|--title łańcuch-printf
- W trybie HTML ustawia tytuł (znacznik <TITLE>) stron man, pobierając parametry takie jak opcja -r.
- -r|--reference|--manref łańcuch-printf
- W trybach HTML i XML określa postać URL, przy pomocy której będą pozyskiwane inne strony podręcznika. Łańcuch może używać dwu podanych parametrów: nazwy strony podręcznika i jej sekcji (zobacz rozdział "Przykłady"). Jeżeli łańcuch jest pusty (tak jak ustawiony z powłoki przez " -r ''"), ma wartość "-" lub "off", to odnośniki występujące na stronie podręcznika nie będą zamieniane na znaczniki HREF, lecz tylko będą zapisywane czcionką pochyłą (italic). Jeśli printf obsługuje określanie pozycji XPG3, to może to być dość elastyczne.
- -V|--volumes <lista rozdzielana drukropkami>
- Ustawia listę dozwolonych wolumenów (sekcji stron podręcznika) sprawdzanych podczas wyszukiwania powiązań z innymi stronami man. Domyślnie jest to 1:2:3:4:5:6:7:8:9:o:l:n:p (nazwy części mogą być wieloznakowe). Jeżeli strona podręcznika zawiera tekst składający się z znaków niebędących spacjami, po których bezpośrednio występują: nawias otwierający, jedna z nazw z powyżej zdefiniowanych sekcji opcjonalnie kończąca się innymi znakami oraz nawias zamykający — to taki tekst jest traktowany jako odnośnik do innej strony podręcznika. Jeżeli w użytej opcji -V łańcuch znaków zaczyna się od znaku równości, to nie są dozwolone żadne dodatkowe znaki pomiędzy dopasowaną nazwą sekcji a nawiasem zamykającym. (Opcja ta jest potrzebna dla SCO UNIX).
- -b|--subsections
- Oprócz tytułów rozdziałów próbuje rozpoznawać tytuły podrozdziałów. W niektórych odmianach może to powodować kłopoty.
- -K|--nobreak
- Określa, że strony podręcznika nie mają łamania stron, zatem nie szuka stopek i nagłówków. (Starsze makra "nroff -man" zawsze wstawiały łamanie strony, ale ostatnio niektórzy dostawcy zauważyli, że wydruki robione są przez troff(1), podczas gdy "nroff -man" służy do formatowania stron do czytania na ekranie, więc usunęli łamanie stron). PolyglotMan zwykle obsługuje tę sytuację poprawnie, nawet bez tego znacznika.
- -k|--keep
- Pozostawia nagłówki i stopki w postaci klasycznego raportu na końcu strony.
- -n|--name nazwa
- Ustawia nazwę strony man (używane w formacie roff). Jeśli nazwę pliku podano w postaci " nazwa.sekcja", to nazwa i sekcja są określane automatycznie. Jeśli strona jest analizowana ze źródła [tn]roff i zawiera wiersz .TH, to są one wyłuskiwane z tego wiersza.
- -p|--paragraph
- Przełącznik trybu akapitów. Zastosowany filtr określa, czy wiersze powinny być łamane, tak jak zrobiłby to nroff, czy też płynąć razem tworząc akapity. Głównie do użytku wewnętrznego.
- -s|section #
- Ustawia numer wolumenu (części, sekcji) strony podręcznika (używane w formacie roff).
- -t|--tabstops #
- Niektóre zestawy makr używają, gdzie to możliwe, tabulatorów zamiast spacji w celu zmniejszenia liczby używanych znaków. Ta opcja ustawia pozycje tabulacji co # kolumn. Domyślnie co 8.