267 lines
8.0 KiB
HTML
267 lines
8.0 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of LEXGROG</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>LEXGROG</H1>
|
|
Section: Narzędzia przeglądarki stron podręcznika ekranowego (1)<BR>Updated: 2020-02-25<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAZWA</H2>
|
|
|
|
lexgrog - przetwarza nagłówki stron podręcznika ekranowego
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SKŁADNIA</H2>
|
|
|
|
<B>lexgrog</B> [<B>-m</B>|<B>-c</B>] [<B>-dfw?V</B>] [<B>-E</B>
|
|
<I>kodowanie_znaków</I>] <I>plik</I> ...
|
|
<A NAME="lbAD"> </A>
|
|
<H2>OPIS</H2>
|
|
|
|
<B>lexgrog</B> jest implementacją w <B>lex</B>ie tradycyjnych narzędzi
|
|
"zgadywanki groffa". Ze swojej linii poleceń czyta listę plików, które
|
|
mogą być albo źródłami stron podręcznika albo preformatowanymi stronami
|
|
"cat", i wyświetla ich nazwy i opisy, tak jak są używane przez
|
|
<B>apropos</B> i <B>whatis</B>, albo listę filtrów preprocesora wymaganych przez
|
|
stronę podręcznika zanim zostanie przekazana do <B>nroff</B> lub <B>troff</B>, albo
|
|
obie te listy.
|
|
<P>
|
|
|
|
Jeżeli wejście <B>lexgrog</B> jest w złym formacie, to wypisze on komunikat
|
|
"parse failed"; może to być użyteczne dla zewnętrznych programów
|
|
sprawdzających poprawność stron podręcznika. Jeżeli jednym z plików
|
|
wejściowych <B>lexgrog</B>a jest "-", to będzie czytał ze swojego
|
|
standardowego wejścia; jeśli plik wejściowy jest skompresowany, to go
|
|
automatycznie zdekompresuje.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPCJE</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-d</B>, <B>--debug</B>
|
|
|
|
|
|
<DD>
|
|
Wyświetla informację diagnostyczną (debug).
|
|
<DT id="2"><B>-m</B>, <B>--man</B>
|
|
|
|
|
|
<DD>
|
|
Przetwarza wejście jako pliki źródłowe stron podręcznika ekranowego. Jest to
|
|
zachowanie domyślne, jeśli nie podano ani <B>--man</B>, ani <B>--cat</B>.
|
|
<DT id="3"><B>-c</B>, <B>--cat</B>
|
|
|
|
|
|
<DD>
|
|
Przetwarza wejście jako sformatowane wcześniej strony podręcznika ekranowego
|
|
("strony cat"). <B>--man</B> i <B>--cat</B> nie mogą być użyte jednocześnie.
|
|
<DT id="4"><B>-w</B>, <B>--whatis</B>
|
|
|
|
|
|
<DD>
|
|
Wyświetla nazwę i opis z nagłówka strony podręcznika ekranowego, używanego
|
|
przez <B>apropos</B> i <B>whatis</B>. Jest to domyślne zachowanie, jeżeli nie podano
|
|
ani <B>--whatis</B>, ani <B>--filters</B>.
|
|
<DT id="5"><B>-f</B>, <B>--filters</B>
|
|
|
|
|
|
<DD>
|
|
Wyświetla listę filtrów potrzebnych do wstępnego przetworzenia strony
|
|
podręcznika zanim zostanie sformatowana przez program <B>nroff</B> lub <B>troff</B>.
|
|
<DT id="6"><B>-E</B> <I>kodowanie_znaków</I>, <B>--encoding</B> <I>kodowanie_znaków</I><DD>
|
|
Nadpisuje odgadnięte kodowanie znaków strony podręcznika, ustawiając je na
|
|
<I>kodowanie_znaków</I>.
|
|
<DT id="7"><B>-?</B>, <B>--help</B>
|
|
|
|
|
|
<DD>
|
|
Wyświetla komunikat pomocy i kończy pracę.
|
|
<DT id="8"><B>--usage</B>
|
|
|
|
|
|
<DD>
|
|
Wyświetla krótki opis użycia programu i kończy pracę.
|
|
<DT id="9"><B>-V</B>, <B>--version</B>
|
|
|
|
|
|
<DD>
|
|
Wyświetla informację o wersji.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>KOD ZAKOŃCZENIA</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="10"><B>0</B>
|
|
|
|
|
|
<DD>
|
|
Program zakończony bez żadnych błędów.
|
|
<DT id="11"><B>1</B>
|
|
|
|
|
|
<DD>
|
|
Błąd użycia.
|
|
<DT id="12"><B>2</B>
|
|
|
|
|
|
<DD>
|
|
<B>lexgrog</B> nie umiał przetworzyć jednego lub więcej spośród plików
|
|
wejściowych.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>PRZYKŁADY</H2>
|
|
|
|
<PRE>
|
|
$ lexgrog man.1
|
|
man.1: "man - an interface to the system reference manuals"
|
|
$ lexgrog -fw man.1
|
|
man.1 (t): "man - an interface to the system reference manuals"
|
|
$ lexgrog -c whatis.cat1
|
|
whatis.cat1: "whatis - display manual page descriptions"
|
|
$ lexgrog broken.1
|
|
broken.1: parse failed
|
|
</PRE>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>PRZETWARZANIE WHATIS</H2>
|
|
|
|
<B>mandb</B> (oparty na tym samym kodzie, co <B>lexgrog</B>) przetwarza sekcję
|
|
<B>NAZWA</B> (<B>NAME</B>) znajdującą się samej górze strony podręcznika ekranowego,
|
|
szukając w niej nazw i opisów. Mimo że parser jest całkiem tolerancyjny,
|
|
ponieważ musi sobie radzić z rożnymi formatami, które były używane na
|
|
przestrzeni lat, to jednak czasem nie potrafi wyciągnąć potrzebnych
|
|
informacji.
|
|
<P>
|
|
|
|
Jeżeli używany jest tradycyjny zbiór makr <I>man</I>, to poprawna sekcja
|
|
<B>NAZWA</B> wygląda tak jak poniżej:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="13"><DD>
|
|
<PRE>
|
|
<TT>.SH NAZWA
|
|
foo \- program, który coś robi</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Niektóre programy do obsługi stron podręcznika wymagają, aby separator
|
|
'\-' był dokładnie taki, jak to pokazano; <B>mandb</B> jest bardziej
|
|
tolerancyjny, jednakże w celu zachowania kompatybilności z innymi systemami
|
|
dobrym pomysłem jest pozostawienie znaku odwrotnego ukośnika.
|
|
<P>
|
|
|
|
Po lewej stronie może występować kilka nazw, rozdzielonych od siebie
|
|
przecinkami. Nazwy zawierające białe znaki są ignorowane, aby uniknąć
|
|
nieprawidłowego zachowania przy niektórych źle sformatowanych sekcjach
|
|
<B>NAZWA</B>. Tekst po prawej stronie ma dowolną postać i może zajmować wiele
|
|
linii. Jeżeli w tej samej stronie podręcznika udokumentowanych jest kilka
|
|
programów z różnymi opisami, powinna być użyta poniższa forma:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="14"><DD>
|
|
<PRE>
|
|
<TT>.SH NAZWA
|
|
foo, bar \- programy, które coś robią
|
|
.br
|
|
baz \- program, który nic nie robi</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
(Zamiast makra <TT>.br</TT> można użyć makra, które zaczyna nowy akapit, na
|
|
przykład <TT>.PP</TT>.)
|
|
<P>
|
|
|
|
Podczas używania pochodzącego z systemów BSD zbioru makr <I>mdoc</I> poprawna
|
|
sekcja <B>NAZWA</B> powinna wyglądać tak jak poniżej:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="15"><DD>
|
|
<PRE>
|
|
<TT>.Sh NAZWA
|
|
.Nm foo
|
|
.Nd program, który coś robi</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
Jest kilka powszechnych przyczyn, dla których przetwarzanie whatis kończy
|
|
się fiaskiem. Czasami autorzy stron podręcznika zastępują '.SH NAZWA'
|
|
przez '.SH MÓJPROGRAM', co powoduje, że <B>mandb</B> nie potrafi
|
|
odnaleźć potrzebnych informacji. Czasami autorzy umieszczają wprawdzie
|
|
sekcję NAZWA, ale zawierają w niej dowolny tekst zamiast używać 'nazwa
|
|
\- opis'. Jednakże każda składania przypominająca powyższą powinna być
|
|
akceptowana.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>ZOBACZ TAKŻE</H2>
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+apropos">apropos</A></I>(1),
|
|
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+man">man</A></I>(1),
|
|
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?1+whatis">whatis</A></I>(1),
|
|
|
|
|
|
<I><A HREF="/cgi-bin/man/man2html?8+mandb">mandb</A></I>(8)
|
|
|
|
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>UWAGI</H2>
|
|
|
|
<B>lexgrog</B> próbuje przetwarzać pliki zawierające żądania .so, jednakże
|
|
będzie zdolny to zrobić tylko wtedy, gdy pliki te są poprawnie zainstalowane
|
|
w hierarchii stron podręcznika ekranowego.
|
|
<A NAME="lbAK"> </A>
|
|
<H2>AUTOR</H2>
|
|
|
|
Autorami kodu używanego przez program <B>lexgrog</B> do przetwarzania stron
|
|
podręcznika są:
|
|
<P>
|
|
|
|
<PRE>
|
|
Wilf. (<A HREF="mailto:G.Wilford@ee.surrey.ac.uk">G.Wilford@ee.surrey.ac.uk</A>).Fabrizio Polacco (<A HREF="mailto:fpolacco@debian.org">fpolacco@debian.org</A>).Colin Watson (<A HREF="mailto:cjwatson@debian.org">cjwatson@debian.org</A>).</PRE>
|
|
|
|
<P>
|
|
|
|
Colin Watson napisał obecne wcielnie interfejsu linii poleceń i tę stronę
|
|
podręcznika ekranowego.
|
|
<A NAME="lbAL"> </A>
|
|
<H2>TŁUMACZENIE</H2>
|
|
|
|
Wojciech Kotwica w 1999 roku przetłumaczył część stron podręcznika pakietu
|
|
man-db i udostępnił je w ramach Projektu Tłumaczenia Manuali.
|
|
<BR>
|
|
|
|
Robert Luberda tłumaczenie zaktualizował i uzupełnił w roku 2008.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="16"><A HREF="#lbAB">NAZWA</A><DD>
|
|
<DT id="17"><A HREF="#lbAC">SKŁADNIA</A><DD>
|
|
<DT id="18"><A HREF="#lbAD">OPIS</A><DD>
|
|
<DT id="19"><A HREF="#lbAE">OPCJE</A><DD>
|
|
<DT id="20"><A HREF="#lbAF">KOD ZAKOŃCZENIA</A><DD>
|
|
<DT id="21"><A HREF="#lbAG">PRZYKŁADY</A><DD>
|
|
<DT id="22"><A HREF="#lbAH">PRZETWARZANIE WHATIS</A><DD>
|
|
<DT id="23"><A HREF="#lbAI">ZOBACZ TAKŻE</A><DD>
|
|
<DT id="24"><A HREF="#lbAJ">UWAGI</A><DD>
|
|
<DT id="25"><A HREF="#lbAK">AUTOR</A><DD>
|
|
<DT id="26"><A HREF="#lbAL">TŁUMACZENIE</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:20 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|