253 lines
7.2 KiB
HTML
253 lines
7.2 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: Verktyg för sidvisning av manual (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>NAMN</H2>
|
|
|
|
lexgrog - tolka rubrikhuvud i manualsidor
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>lexgrog</B> [<B>-m</B>|<B>-c</B>] [<B>-dfw?V</B>] [<B>-E</B> <I>kodning</I>]
|
|
<I>fil</I> ...
|
|
<A NAME="lbAD"> </A>
|
|
<H2>BESKRIVNING</H2>
|
|
|
|
<B>lexgrog</B> är en implementation av det traditionella verktyget "groff
|
|
guess" i <B>lex</B>. Det läser listan av filer på dess kommandorad antingen
|
|
som källkodsfiler till manualsidor eller förformaterade "cat" sidor,
|
|
och visar deras namn och beskrivning så som de används av <B>apropos</B> och
|
|
<B>whatis</B>, som en lista av preprocessorfilter som krävs av manualsidan innan
|
|
den skickas vidare till <B>nroff</B> eller <B>troff</B>, eller båda delar.
|
|
<P>
|
|
|
|
Om inmatningen är dåligt formaterad kommer <B>lexgrog</B> att skriva ut
|
|
"tolkning misslyckades"; detta kan vara användbart för externa program
|
|
som behöver kontrollera manualsidors korrekthet. Om en av <B>lexgrog</B>:s
|
|
inmatningsfiler är "-" så kommer det att läsa från standard in; om
|
|
någon inmatningsfil är komprimerad kommer en dekomprimerad version
|
|
automatiskt att läsas in.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>FLAGGOR</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-d</B>, <B>--debug</B>
|
|
|
|
|
|
<DD>
|
|
Skriver ut felsökningsinformation.
|
|
<DT id="2"><B>-m</B>, <B>--man</B>
|
|
|
|
|
|
<DD>
|
|
Tolka inmatning som källkodsfiler till manualsidor. Detta är standard om
|
|
varken <B>--man</B> eller <B>--cat</B> anges.
|
|
<DT id="3"><B>-c</B>, <B>--cat</B>
|
|
|
|
|
|
<DD>
|
|
Tolka inmatning som förformaterade manualsidor ("cat-sidor").
|
|
<B>--man</B> och <B>--cat</B> får inte anges samtidigt.
|
|
<DT id="4"><B>-w</B>, <B>--whatis</B>
|
|
|
|
|
|
<DD>
|
|
Visa namnet och beskrivningen från manualsidans rubrikhuvud så som de
|
|
används av <B>apropos</B> och <B>whatis</B>. Detta är standard om varken
|
|
<B>--whatis</B> eller <B>--filters</B> anges.
|
|
<DT id="5"><B>-f</B>, <B>--filters</B>
|
|
|
|
|
|
<DD>
|
|
Visa listan över filter som behövs för att förformatera manualsidan innan
|
|
den formateras med <B>nroff</B> eller <B>troff</B>.
|
|
<DT id="6"><B>-E</B> <I>kodning</I>, <B>--encoding</B> <I>kodning</I><DD>
|
|
Åsidosätt den gissade teckenuppsättningen för sidan och använd <I>kodning</I>.
|
|
<DT id="7"><B>-?</B>, <B>--help</B>
|
|
|
|
|
|
<DD>
|
|
Skriv ut ett hjälpmeddelande och avsluta.
|
|
<DT id="8"><B>--usage</B>
|
|
|
|
|
|
<DD>
|
|
Skriv ut ett kort användningsmeddelande och avsluta.
|
|
<DT id="9"><B>-V</B>, <B>--version</B>
|
|
|
|
|
|
<DD>
|
|
Visa versionsinformation.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>SLUTSTATUS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="10"><B>0</B>
|
|
|
|
|
|
<DD>
|
|
Framgångsrik programexekvering.
|
|
<DT id="11"><B>1</B>
|
|
|
|
|
|
<DD>
|
|
Användningsfel.
|
|
<DT id="12"><B>2</B>
|
|
|
|
|
|
<DD>
|
|
<B>lexgrog</B> misslyckades med att tolka en eller flera av dess
|
|
inmatningsfiler.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>EXEMPEL</H2>
|
|
|
|
<PRE>
|
|
$ lexgrog man.1
|
|
man.1: "man - ett gränssnitt för systemreferensmanualer"
|
|
$ lexgrog -fw man.1
|
|
man.1 (t): "man - ett gränssnitt för systemreferensmanualer"
|
|
$ lexgrog -c whatis.cat1
|
|
whatis.cat1: "whatis - visa beskrivningar för manualsidor"
|
|
$ lexgrog broken.1
|
|
broken.1: tolkning misslyckades
|
|
</PRE>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>WHATIS-TOLKNING</H2>
|
|
|
|
<B>mandb</B> (som använder samma kod som <B>lexgrog</B>) tolkar <B>NAMN</B>-avsnittet
|
|
längst upp på varje manualsida och letar efter namn och beskrivningar för de
|
|
funktioner som dokumenteras i varje sida. Även om tolken är tämligen
|
|
tolerant, då den varit tvungen att klara av ett antal olika format som
|
|
använts historiskt, kan den ibland misslyckas med att extrahera den begärda
|
|
informationen.
|
|
<P>
|
|
|
|
När den traditionella makrouppsättningen <I>man</I> används ser ett
|
|
<B>NAMN</B>-avsnitt ut ungefär så här:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="13"><DD>
|
|
<PRE>
|
|
<TT>.SH NAMN
|
|
foo \- program som gör någonting</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Vissa manualsidor kräver att '\-' anges exakt som visats; <B>mandb</B>
|
|
är mer tolerant, men för kompatibilitet med andra system är det trots detta
|
|
en bra idé att behålla bakstrecket.
|
|
<P>
|
|
|
|
På vänstersidan kan det finnas flera namn, separerade av komman. Namn som
|
|
innehåller blanksteg kommer att ignoreras för att undvika felaktigt beteende
|
|
för vissa dåligt namngivna <B>NAMN</B>-avsnitt. Texten på höger sida är
|
|
friformstext och får sträcka sig över flera rader. Om flera funktioner med
|
|
olika beskrivningar dokumenteras på samma manualsida ska därför följande
|
|
form användas:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="14"><DD>
|
|
<PRE>
|
|
<TT>.SH NAMN
|
|
foo, bar \- program som gör någonting
|
|
.br
|
|
baz \- program som inte gör någonting</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
(Ett makro som påbörjar ett nytt stycke, så som <TT>.PP</TT>, kan användas
|
|
istället för avbrytningsmakrot <TT>.br</TT>.)
|
|
<P>
|
|
|
|
När den BSD-baserade makrouppsättningen <I>mdoc</I> används ser ett
|
|
<B>NAMN</B>-avsnitt ut ungefär så här:
|
|
<P>
|
|
|
|
<DL COMPACT><DT id="15"><DD>
|
|
<PRE>
|
|
<TT>.Sh NAMN
|
|
.Nm foo
|
|
.Nd program som för någonting</TT>
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
Det finns flera anledningar till varför whatis-tolkning misslyckas. Ibland
|
|
ersätter upphovsmännen till manualsidorna '.SH NAMN' med '.SH
|
|
MITTPROGRAM' och så kan inte <B>mandb</B> hitta avsnittet från vilket
|
|
informationen det behöver ska extraheras. Ibland inkluderar upphovsmännen
|
|
NAMN-avsnittet, men placerar friformstext där snarare än 'namn \-
|
|
beskrivning'. Syntax som är lik ovanstående bör dock accepteras.
|
|
<A NAME="lbAI"> </A>
|
|
<H2>SE VIDARE</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>NOTERINGAR</H2>
|
|
|
|
<B>lexgrog</B> försöker att tolka filer som innehåller .so-begäran men kommer
|
|
endast att lyckas göra det korrekt om filerna är korrekt installerade i
|
|
hierarkin av manualsidor.
|
|
<A NAME="lbAK"> </A>
|
|
<H2>UPPHOVSMAN</H2>
|
|
|
|
Koden som används av <B>lexgrog</B> för att genomsöka manualsidor skrevs av:
|
|
<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 skrev den innevarande inkarnationen av
|
|
kommandoradsgränssnittet, såväl som denna manualsida.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="16"><A HREF="#lbAB">NAMN</A><DD>
|
|
<DT id="17"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="18"><A HREF="#lbAD">BESKRIVNING</A><DD>
|
|
<DT id="19"><A HREF="#lbAE">FLAGGOR</A><DD>
|
|
<DT id="20"><A HREF="#lbAF">SLUTSTATUS</A><DD>
|
|
<DT id="21"><A HREF="#lbAG">EXEMPEL</A><DD>
|
|
<DT id="22"><A HREF="#lbAH">WHATIS-TOLKNING</A><DD>
|
|
<DT id="23"><A HREF="#lbAI">SE VIDARE</A><DD>
|
|
<DT id="24"><A HREF="#lbAJ">NOTERINGAR</A><DD>
|
|
<DT id="25"><A HREF="#lbAK">UPPHOVSMAN</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:23 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|