1 This is help2man-sv.info.tmp, produced by makeinfo version 6.7 from
4 Denna fil dokumenterar GNU ‘help2man’-kommandot som producerar enkla
5 manualsidor givet utmatningen från ‘--help’ och ‘--version’ från andra
8 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010,
9 2011, 2012, 2013, 2014, 2015, 2020 Free Software Foundation, Inc.
11 Tillstånd ges till att skapa och distribuera ordagranna kopior av
12 denna manual givet att upphovsrättsinformationen och denna tillåtelsenot
13 bevaras i alla kopior.
15 Tillstånd ges till att kopia och distribuera modifierade versioner av
16 denna manual under villkoren för ordagrann kopiering, givet att hela det
17 resultatet distribueras under en med denna identisk tillåtelsenot.
19 Tillstånd ges till att kopiera och distribuera översättningar av
20 denna manual till andra språk, under ovanstående villkor för modifierade
21 versioner, förutom att denna tillåtelsenotis måste uttryckas i en
22 översättning som godkänts av Stiftelsen.
23 INFO-DIR-SECTION Mjukvaruutveckling
25 * help2man-sv: (help2man-sv). Automatisk generering av manualsida.
29 File: help2man-sv.info.tmp, Node: Top, Next: Översikt, Up: (dir)
34 ‘help2man’ producerar enkal manualsidor givet utmatningen från ‘--help’
35 och ‘--version’ från andra kommandon.
39 * Översikt:: Översikt av ‘help2man’.
40 * Anropa help2man:: Hur man kör ‘help2man’.
41 * --help-rekommendationer:: Rekommenderad formatering av
43 * Inkludera text:: Inkludera ytterligare text i utmatningen.
44 * Användning av Makefiler:: Användning av ‘help2man’ med‘make’.
45 * Lokaliserade manualsidor:: Att producera manualsidor på
47 * Exempel:: Exempel på ‘help2man’-utmatning.
48 * Rapportering:: Att rapportera fel eller förslag.
49 * Tillgänglighet:: Att få tag i ‘help2man’.
52 File: help2man-sv.info.tmp, Node: Översikt, Next: Anropa help2man, Prev: Top, Up: Top
54 1 Översikt över ‘help2man’
55 **************************
57 ‘help2man’ är ett verktyg som automatiskt genererar enkla manualsidor
58 från programutmatning.
60 Även om manualsidor är valfria för GNU program så kräver andra
61 projekt så som Debian dem (*note (standards)Man Pages::)
63 Detta program är avsett att tillhandahålla ett enkelt sätt för
64 programvaruutvecklare att inkludera en manualsidor i deras distribution
65 utan att behöva underhålla det dokumentet.
67 Givet ett program som producerar rimlig standardlik utdata från
68 ‘--help’ och ‘--version’ kan ‘help2man’ omarrangera utmatningen till
69 något som liknar en manualsida.
72 File: help2man-sv.info.tmp, Node: Anropa help2man, Next: --help-rekommendationer, Prev: Översikt, Up: Top
74 2 Hur man kör ‘help2man’
75 ************************
77 Formatet för att köra programmet ‘help2man’ är:
79 help2man [FLAGGA]... KÖRBAR FIL
81 ‘help2man’ har stöd för följande flaggor:
85 Använd STRÄNG som en beskrivning för ‘NAMN’-avsnittet i
88 Som standard (i brist på något bättre) innehåller detta avsitt
89 ‘manualsida för PROGRAM VERSION’.
91 Denna flagga åsidosätter en inkluderingsfil ‘[namn]’-avsnitt (*note
96 Använd AVSNITT som avsnittet för manualsidan. Standardavsnittet är
101 Ställ in namnet på manualavsnittet till AVSNITT, används som en
102 centrerad rubrik för manualsidan. Som standard används
103 ‘Användarkommandon’ för sidor i avsnitt 1, ‘Spel’ för avsnitt 6 och
104 ‘Systemadministrationsverktyg’ för avsnitt 8 och 1M.
108 Prorgramkällan används som en sidfot och innehåller ofta namnet på
109 organisationen eller sviten som programmet är en del av. Som
110 standard är värdet paketnamnet och versionen.
114 Välj utmatningslokal (standardvärdet är ‘C’). Både programmet och
115 ‘help2man’ måste ha stöd för den angivna LOKALEN (*note
116 Lokaliserade manualsidor::).
120 Inkludera material från FIL (*note Inkludera text::).
124 En variant av ‘--include’ för användning i Makefile-mönsterregler
125 som inte kräver att FIL existerar.
129 Skicka utmatning till FIL snarare än ‘stdout’.
133 Namn för Texinfo-manualen.
137 Undertryck inkludering av ett ‘SE OCKSÅ’-stycke som dirigerar
138 läsaren till Textinfo-dokumentationen.
142 Skippa ‘lt-’-prefix från instanser av programnamnet i synopsis
143 (‘libtool’ skapar omslagsskript i byggkatalogen vilka startar ‘foo’
148 Visa hjälp eller versionsinformation.
150 Som standard skickar ‘help2man’ standardflaggor som ‘--help’ och
151 ‘--version’ till den körbara filen trots att alternativ kan anges via:
154 ‘--help-option=FLAGGA’
155 Sträng för hjälpflagga.
158 ‘--version-option=FLAGGA’
159 Sträng för versionsflagga.
161 ‘--version-string=STRÄNG’
164 ‘--no-discard-stderr’
165 Inkludera stderr när flaggutmatning tolkas.
168 File: help2man-sv.info.tmp, Node: --help-rekommendationer, Next: Inkludera text, Prev: Anropa help2man, Up: Top
170 3 ‘--help’ Rekommendationer
171 ***************************
173 Här följer några rekommendationer för vad som bör inkluderas i din
174 ‘--help’-utmatning. Att inkludera dessa ger ‘help2man’ bästa möjliga
175 chans att generera en respektabel manualsida, samtidigt som det direkt
178 Se *note (standards)Command-Line Interfaces:: och *note
179 (standards)Man Pages::, för den officiella GNU standarden som relaterat
180 till ‘--help’ och manualsidor.
182 • En sammanfattning om hur programmet kan startas. Om olika
183 användningar av programmet har olika sätt att starta dem på, då
184 listas allihop. Till exempel (redigerad för korthet):
186 Användning: cp [FLAGGA]… KÄLLA DEST
187 eller: cp [FLAGGA]… KÄLLA… KATALOG
190 Använd ‘argv[0]’ för programnamnet i dessa synopsisar, precis som
191 det är, utan katalogstrippning. Detta står i kontrast till det
192 kanoniska (konstanta) namnet för programmet vilket används i
195 • En väldig kort förklaring av vad programmet gör, inklusive
196 standard- och/eller typiskt beteende. Här är till exempel ‘cp’’s:
198 Kopiera KÄLLA till DEST, eller flera KÄLL(or) till KATALOG.
200 • En lista över flaggor, indenterade till kolumn 2. Om programmet
201 har stöd för enteckensflaggor, lägg dessa först och sedan den
202 ekvivalenta långa flaggan (om en sådan finns). Om flaggan tar ett
203 argument, inkludera det också, ge det ett meningsfullt namn.
204 Justera beskrivningarna längs en lämplig kolumn om önskat. Notera
205 att för att detekteras korrekt av ‘help2man’ måste beskrivningen
206 separeras från flaggorna med åtminstone två blanksteg och
207 beskrivningar som fortsätter på efterföljande rader måste börja på
210 Här är igen ett (redigerat) utdrag från ‘cp’, vilket visar en kort
211 flagga med en ekvivalent lång flagga, enbart en lång flagga, samt
212 enbart en kort flagga:
214 -a, --archive samma som -dpR
215 --backup[=KONTROLL] gör en säkerhets kopia av varje…
218 För ett program som tar många flaggor kan det vara önskvärt att
219 dela upp flagglistan i avsnitt så som ‘Globala’,
220 ‘Utmatningskontroll’, eller vad som verkar vara vettigt i det
221 enskilda fallet. Det är vanligvis bäst att sortera alfabetiskt
222 (först efter korta flaggnamn, sedan långa) inom varje avsnitt,
223 eller hela listan om det inte finns några avsnitt.
225 • Ytterligare användbart information om programmets beteende så som
226 miljövariabler som påverkar, vidare förklaring av flaggor, etc.
227 Till exempel diskuterar ‘cp’ ‘VERSION_CONTROL’ och glesa filer.
229 • Ett par exempel på typisk användning. Ett bra exempel är
230 vanligtvis värt en beskrivning om tusen ord, så detta rekommenderas
233 • Sammanfattningsvis, en rad som beskriver hur man skickar
234 felrapporter per e-post. Vanligtvis kommer MAILING-ADDRESS att
235 vara ‘bugPROGRAM@gnu.org’; använd denna format för GNU-program när
236 det är möjligt. Det är också bra att nämna hemsidan för
237 programmer, andra sändlistor, etc.
239 Programmeringsgränssnitten ‘argp’ och ‘popt’ låter dig ange
240 flaggbeskrivningar för ‘--help’ på samma struktur som resten av
241 flaggdefinitionen; möjligen bör du överväga att använda dessa rutiner
242 för flaggtolkning instället för ‘getopt’.
244 Som standard har ‘help2text’ samma heuristik för att identifiera
245 avsnitt på manualsidor: en rad som består av ‘Flaggor:’ kommer till
246 exempel att orsaka att följande text dyka upp i avsnittet ‘FLAGGOR’, och
247 en rad som börjar med ‘Copyright’ kommer att dyka upp i avsnittet
248 ‘UPPHOVSRÄTT’. Utöver denna heuristik kommer en rad som består av
249 ‘*Ord*’ att påbörja ett nytt avsnitt och ‘Ord:’ ett nytt underavsnitt.
252 File: help2man-sv.info.tmp, Node: Inkludera text, Next: Användning av Makefiler, Prev: --help-rekommendationer, Up: Top
254 4 Inkludera ytterligare text i utmatningen
255 ******************************************
257 Ytterligare statisk text kan inkluderas i den genererade manualsidan
258 genom att använda flaggorna ‘--include’ och ‘--opt-include’ (*note
259 Anropa help2man::). Även om dessa filer kan heta vad som helst,
260 föreslår vi för att vara konsekventa att använda filändelsen ‘.h2m’ för
261 inkluderingsfiler för ‘help2man’.
263 Formatet för för filer som inkluderas via dessa flaggor är enkelt:
271 Block av ordagrann *roff-text infogas i utmatningen antingen vid
272 början av det angivna ‘[avsnittet]’ (skiftlägeskänsligt), eller efter
273 ett styck som matchar mönstret ‘/mönster/’.
275 Mönster använder Perls syntax för reguljärauttryck och kan följas av
276 modifierarna ‘i’, ‘s’ eller ‘m’ (*note pelre(1): (*manualsidor*)perlre.)
278 Rader innan det första avsnittet eller mönstret vilket börjar med ‘-’
279 hanteras som flaggor. Allting annars hoppas över utan anmärkning och
280 kan användas för kommentarer, RCS-nyckelord och liknande.
282 Utmatningsordningen för (de inkluderade) avsnitten är:
297 De ‘[namn]’- eller ‘[synopsis]’-avsnitt som förekommer i
298 inkluderingsfilen kommer att ersätta vad som automatiskt hade
299 producerats (även om du fortfarande kan åsidosätta den föregående med
300 ‘--namn’ om så behövs).
302 Andra avsnitt läggs före den automatiskt producerade utmatningen för
303 standardavsnitt angivna ovan, eller inkluderade vid _annat_ (ovan) i den
304 ordning de påträffades i inkluderingsfilen.
306 Placering av text inom avsnitt kan uttryckligen begäras med syntaxen
307 ‘[<avsnitt]’, ‘[=avsnitt]’ eller ‘[>avsnitt]’ för att placera den extra
308 texten före, istället för, respektive efter standardutmatningen.
311 File: help2man-sv.info.tmp, Node: Användning av Makefiler, Next: Lokaliserade manualsidor, Prev: Inkludera text, Up: Top
313 5 Att använda ‘help2man’ med ‘make’
314 ***********************************
316 En föreslagen användning av ‘help2man’ i Makefiler är att låta
317 manualsidan bero in på binären, men på källkodsfilerna i vilka ‘--help’
318 och ‘--version’-utmatningen definieras.
320 Denna användning tillåter en manualsida att genereras av
321 upphovsmannen och inkluderas i distributionen utan att kräva att
322 slutanvändaren har ‘help2man’ installerat.
324 En exempelregel för programmet ‘prog’ kunde vara:
326 prog.1: $(srcdir)/main.c
327 -$(HELP2MAN) --output=$@ --name='ett exempelprogram' ./prog
329 Värdet på ‘HELP2MAN’ kan sättas i ‘configure.in’ via endera av:
331 AM_MISSING_PROG(HELP2MAN, help2man)
333 för ‘automake’, eller något liknande:
335 AC_PATH_PROG(HELP2MAN, help2man, false // No help2man //)
337 endast för ‘autoconf’.
340 File: help2man-sv.info.tmp, Node: Lokaliserade manualsidor, Next: Exempel, Prev: Användning av Makefiler, Up: Top
342 6 Att producera manualsidor på modersmål
343 ****************************************
345 Manualsidor kan produceras för vilken lokal som stöds av både programmet
346 och ‘help2man’ med flaggan ‘--locale’ (‘-L’).
348 help2man -L fr_FR@euro -o cp.fr.1 cp
350 Se <http://translationproject.org/domain/help2man.html> för språken
351 som för närvarande stöds av ‘help2man’, och *note Rapportering:: för hur
352 man skickar in andra översättningar.
354 6.1 Att ändra platsen för meddelandekataloger
355 =============================================
357 När du skapar lokaliserade manualsidor från ett program byggkatalog är
358 det sannolikt att översättningarna installerade på standardplatsen (om
359 de ens är installerade) inte kommer att vara korrekt för versionen av
360 programmet som byggs.
362 Ett förinläsningsbart bibliotek tillhandahålls tillsammans med
363 ‘help2man’, vilket kommer att fånga upp anrop till ‘bindtextdomain’ som
364 konfigurerar platsen för meddelande kataloger för domänen som anges av
365 ‘$TEXTDOMAIN’ och åsidosätter platsen för sökvägen given av
370 mkdir -p tmp/fr/LC_MESSAGES
371 cp po/fr.gmo tmp/fr/LC_MESSAGES/PROG.mo
372 LD_PRELOAD="/usr/lib/help2man/bindtextdomain.so" \
375 help2man -L fr_FR@euro -i PROG.fr.h2m -o PROG.fr.1 PROG
378 koller att orsaka att PROG läser in meddelandekatalogen från ‘tmp’
379 snarare än ‘/usr/share/local’.
382 • Generaliseringen av ‘fr_FR@euro’ till ‘fr’ i exemplet ovan görs av
383 ‘gettext’, om en mer specifik matchning fanns tillgänglig hade det
384 också blivit ommappat.
386 • Denna förinläsning har endast testats mot ‘eglibc’ 2.11.2 och
387 ‘gettext’ 0.18.1.1 på ett GNU/Linux-system; låt mig vet om det
388 fungerar (eller ej) för dig (*note Rapportering::).
391 File: help2man-sv.info.tmp, Node: Exempel, Next: Rapportering, Prev: Lokaliserade manualsidor, Up: Top
393 7 Exempel på ‘help2man’-utdata
394 ******************************
396 Givet ett hypotetiskt program ‘foo’ vilket producerar följande
402 Copyright (C) 2011 Free Software Foundation, Inc.
403 Detta är fri programvara; se källkoden för kopieringsvillkor. Det finns INGEN
404 garanti; inte ens underförstådd garanti om SÄLJBARHET eller LÄMPLIGHET För NÅGOT SPECIELLT ÄNDAMÅL.
406 Skrivet av E. N. Programmerare.
408 GNU `foo' gör ingenting intressant förutom att fungera som ett exempel för
411 Användning: foo [FLAGGA]…
414 -a, --flagga en flagga
415 -b, --annan-flagga[=VÄRDE]
418 --help visa den hjälp och avsluta
419 --version mata ut versionsinformation och avsluta
423 foo --flagga samma sak, men ange `--flagga'
425 Rapportera fel till <bug-gnu-utils@gnu.org>.
427 ‘help2man’ kommer att producera ‘nroff’-indata för en manualsida som
428 kommer att formateras enligt något som liknar:
430 FOO(1) Användarkommandon FOO(1)
433 foo - manualsida för foo 1.1
439 GNU ”foo” gör ingenting intressant förutom att fungera som exempel
446 -b, --annan-flagga[=VÄRDE]
449 --help visar denna hjälptext och avslutar
452 skriv ut versionsinformation och avsluta
458 samma sak, anger ”--flagga”
461 Skrivet av E. N. Programmerare.
464 Rapportera fel till <bug-gnu-utils@gnu.org>.
467 Copyright © 2011 Free Software Foundation, Inc.
468 This is free software; see the source for copying conditions.
469 There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
473 Den fullständiga dokumentationen för foo upprätthålls som en Texinfo-manual.
474 Om info och foo programmen är korrekt installerade hos dig,
479 ge dig tillgång till den fullständiga manualen.
481 foo 1.1 Maj 2011 FOO(1)
484 File: help2man-sv.info.tmp, Node: Rapportering, Next: Tillgänglighet, Prev: Exempel, Up: Top
486 8 Rapportera fel elelr förslag
487 ******************************
489 Om du hittar problem eller har förslag om detta program eller denna
490 manual, rapportera dem till <bug-help2man@gnu.org>.
492 Not till översättare: Översättningar hanteras via Translation Project
493 (http://translationproject.org/) se
494 <http://translationproject.org/html/translators.html> för vidare
498 File: help2man-sv.info.tmp, Node: Tillgänglighet, Prev: Rapportering, Up: Top
500 9 Få tag i ‘help2man’
501 *********************
503 Den senaste versionen av denna distribution är tillgänglig på nätet från
506 <http://ftpmirror.gnu.org/help2man/>
508 Om automatisk omdirigering misslyckas så finns listan över speglar
511 <http://www.gnu.org/order/ftp.html>
513 Eller om det behövs så kan du använda GNU:s huvudsakliga ftp-server:
514 <http://ftp.gnu.org/gnu/help2man/>
519 Node: Översikt
\7f2086
520 Node: Anropa help2man
\7f2842
521 Node: --help-rekommendationer
\7f5688
522 Node: Inkludera text
\7f9864
523 Node: Användning av Makefiler
\7f12013
524 Node: Lokaliserade manualsidor
\7f13025
525 Node: Exempel
\7f15065
526 Node: Rapportering
\7f17868
527 Node: Tillgänglighet
\7f18345