1 This is help2man-sv.info.tmp, produced by makeinfo version 6.8 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, 2021 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 Programvaruutveckling
25 * help2man-sv: (help2man-sv). Automatisk generering av manualsida.
29 File: help2man-sv.info.tmp, Node: Top, Next: Översikt, Up: (dir)
34 ‘help2man’ producerar enkla 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
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 manualsida 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 avsnitt
89 ‘manualsida för PROGRAM VERSION’.
91 Denna flagga åsidosätter en inkluderingsfils ‘[namn]’-avsnitt
92 (*note Inkludera text::).
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 Programkä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 VIDARE’-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 Rekommendationer för ‘--help’
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 relaterad till
180 ‘--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 MÅL
187 eller: cp [FLAGGA]… KÄLLA… KATALOG
190 Använd ‘argv[0]’ för programnamnet i dessa synopser, precis som det
191 ä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 den för
199 Kopiera KÄLLA till MÅL, eller flera KÄLL(or) till KATALOG.
201 • En lista över flaggor, indenterade till kolumn 2. Om programmet
202 har stöd för enteckensflaggor, lägg dessa först och sedan den
203 ekvivalenta långa flaggan (om en sådan finns). Om flaggan tar ett
204 argument, inkludera det också, ge det ett meningsfullt namn.
205 Justera beskrivningarna längs en lämplig kolumn om önskat. Notera
206 att för att detekteras korrekt av ‘help2man’ måste beskrivningen
207 separeras från flaggorna med åtminstone två blanksteg och
208 beskrivningar som fortsätter på efterföljande rader måste börja på
211 Här är igen ett (redigerat) utdrag från ‘cp’, vilket visar en kort
212 flagga med en ekvivalent lång flagga, enbart en lång flagga, samt
213 enbart en kort flagga:
215 -a, --archive samma som -dpR
216 --backup[=KONTROLL] gör en säkerhetskopia av varje…
219 För ett program som tar många flaggor kan det vara önskvärt att
220 dela upp flagglistan i avsnitt så som ‘Globala’,
221 ‘Utmatningskontroll’, eller vad som verkar vara vettigt i det
222 enskilda fallet. Det är vanligtvis bäst att sortera alfabetiskt
223 (först efter korta flaggnamn, sedan långa) inom varje avsnitt,
224 eller hela listan om det inte finns några avsnitt.
226 • Ytterligare användbar information om programmets beteende så som
227 miljövariabler som påverkar, vidare förklaring av flaggor o.s.v.
228 Till exempel diskuterar ‘cp’ ‘VERSION_CONTROL’ och glesa filer.
230 • Ett par exempel på typisk användning. Ett bra exempel är
231 vanligtvis värt en beskrivning om tusen ord, så detta rekommenderas
234 • Sammanfattningsvis, en rad som beskriver hur man skickar
235 felrapporter per e-post. Vanligtvis kommer MAILING-ADDRESS att
236 vara ‘bug-PROGRAM@gnu.org’; använd denna format för GNU-program när
237 det är möjligt. Det är också bra att nämna webbsidan för
238 programmet, andra sändlistor o.s.v.
240 Programmeringsgränssnitten ‘argp’ och ‘popt’ låter dig ange
241 flaggbeskrivningar för ‘--help’ på samma struktur som resten av
242 flaggdefinitionen; möjligen bör du överväga att använda dessa rutiner
243 för flaggtolkning istället för ‘getopt’.
245 Som standard har ‘help2text’ samma heuristik för att identifiera
246 avsnitt på manualsidor: en rad som består av ‘Flaggor:’ kommer till
247 exempel att orsaka att följande text dyker upp i avsnittet ‘FLAGGOR’,
248 och en rad som börjar med ‘Copyright’ kommer att dyka upp i avsnittet
249 ‘UPPHOVSRÄTT’. Utöver denna heuristik kommer en rad som består av
250 ‘*Ord*’ att påbörja ett nytt avsnitt och ‘Ord:’ ett nytt underavsnitt.
253 File: help2man-sv.info.tmp, Node: Inkludera text, Next: Användning av Makefiler, Prev: --help-rekommendationer, Up: Top
255 4 Inkludera ytterligare text i utmatningen
256 ******************************************
258 Ytterligare statisk text kan inkluderas i den genererade manualsidan
259 genom att använda flaggorna ‘--include’ och ‘--opt-include’ (*note
260 Anropa help2man::). Även om dessa filer kan heta vad som helst,
261 föreslår vi för att vara konsekventa att använda filändelsen ‘.h2m’ för
262 inkluderingsfiler för ‘help2man’.
264 Formatet för filer som inkluderas via dessa flaggor är enkelt:
272 Block av ordagrann *roff-text infogas i utmatningen antingen vid
273 början av det angivna ‘[avsnittet]’ (skiftlägeskänsligt), eller efter
274 ett stycke som matchar mönstret ‘/mönster/’.
276 Mönster använder Perls syntax för reguljära uttryck och kan följas av
277 modifierarna ‘i’, ‘s’ eller ‘m’ (*note perlre(1):
278 (*manualsidor*)perlre.)
280 Rader innan det första avsnittet eller mönstret vilket börjar med ‘-’
281 hanteras som flaggor. Allting annars hoppas över utan anmärkning och
282 kan användas för kommentarer, RCS-nyckelord och liknande.
284 Utmatningsordningen för (de inkluderade) avsnitten är:
299 De ‘[namn]’- eller ‘[synopsis]’-avsnitt som förekommer i
300 inkluderingsfilen kommer att ersätta vad som automatiskt hade
301 producerats (även om du fortfarande kan åsidosätta den föregående med
302 ‘--namn’ om så behövs).
304 Andra avsnitt läggs före den automatiskt producerade utmatningen för
305 standardavsnitt angivna ovan, eller inkluderade vid _annat_ (ovan) i den
306 ordning de påträffades i inkluderingsfilen.
308 Placering av text inom avsnitt kan uttryckligen begäras med syntaxen
309 ‘[<avsnitt]’, ‘[=avsnitt]’ eller ‘[>avsnitt]’ för att placera den extra
310 texten före, istället för, respektive efter standardutmatningen.
313 File: help2man-sv.info.tmp, Node: Användning av Makefiler, Next: Lokaliserade manualsidor, Prev: Inkludera text, Up: Top
315 5 Att använda ‘help2man’ med ‘make’
316 ***********************************
318 En föreslagen användning av ‘help2man’ i Makefiler är att låta
319 manualsidan bero inte på binären, utan på källkodsfilerna i vilka
320 ‘--help’ och ‘--version’-utmatningen definieras.
322 Denna användning tillåter en manualsida att genereras av
323 upphovsmannen och inkluderas i distributionen utan att kräva att
324 slutanvändaren har ‘help2man’ installerat.
326 En exempelregel för programmet ‘prog’ kunde vara:
328 prog.1: $(srcdir)/main.c
329 -$(HELP2MAN) --output=$@ --name='ett exempelprogram' ./prog
331 Värdet på ‘HELP2MAN’ kan sättas i ‘configure.in’ via endera av:
333 AM_MISSING_PROG(HELP2MAN, help2man)
335 för ‘automake’, eller något liknande:
337 AC_PATH_PROG(HELP2MAN, help2man, false // No help2man //)
339 endast för ‘autoconf’.
342 File: help2man-sv.info.tmp, Node: Lokaliserade manualsidor, Next: Exempel, Prev: Användning av Makefiler, Up: Top
344 6 Att producera manualsidor på modersmål
345 ****************************************
347 Manualsidor kan produceras för de lokaler som stöds av både programmet
348 och ‘help2man’ med flaggan ‘--locale’ (‘-L’).
350 help2man -L fr_FR@euro -o cp.fr.1 cp
352 Se <http://translationproject.org/domain/help2man.html> för språken
353 som för närvarande stöds av ‘help2man’, och *note Rapportering:: för hur
354 man skickar in andra översättningar.
356 6.1 Att ändra platsen för meddelandekataloger
357 =============================================
359 När du skapar lokaliserade manualsidor från ett programs byggkatalog är
360 det sannolikt att översättningarna installerade på standardplatsen (om
361 de ens är installerade) inte kommer att vara korrekta för versionen av
362 programmet som byggs.
364 Ett förinläsningsbart bibliotek tillhandahålls tillsammans med
365 ‘help2man’, vilket kommer att fånga upp anrop till ‘bindtextdomain’ som
366 konfigurerar platsen för meddelandekataloger för domänen som anges av
367 ‘$TEXTDOMAIN’ och åsidosätter platsen för sökvägen given av
372 mkdir -p tmp/fr/LC_MESSAGES
373 cp po/fr.gmo tmp/fr/LC_MESSAGES/PROG.mo
374 LD_PRELOAD="/usr/lib/help2man/bindtextdomain.so" \
377 help2man -L fr_FR@euro -i PROG.fr.h2m -o PROG.fr.1 PROG
380 kommer att orsaka att PROG läser in meddelandekatalogen från ‘tmp’
381 snarare än ‘/usr/share/local’.
384 • Generaliseringen av ‘fr_FR@euro’ till ‘fr’ i exemplet ovan görs av
385 ‘gettext’, om en mer specifik matchning fanns tillgänglig hade det
386 också blivit ommappat.
388 • Denna förinläsning har endast testats mot ‘eglibc’ 2.11.2 och
389 ‘gettext’ 0.18.1.1 på ett GNU/Linux-system; låt mig veta om det
390 fungerar (eller ej) för dig (*note Rapportering::).
393 File: help2man-sv.info.tmp, Node: Exempel, Next: Rapportering, Prev: Lokaliserade manualsidor, Up: Top
395 7 Exempel på ‘help2man’-utdata
396 ******************************
398 Givet ett hypotetiskt program ‘foo’ vilket producerar följande
404 Copyright (C) 2011 Free Software Foundation, Inc.
405 Detta är fri programvara; se källkoden för kopieringsvillkor. Det finns INGEN
406 garanti; inte ens underförstådd garanti om SÄLJBARHET eller LÄMPLIGHET För NÅGOT SPECIELLT ÄNDAMÅL.
408 Skrivet av E. N. Programmerare.
410 GNU `foo' gör ingenting intressant förutom att fungera som ett exempel för
413 Användning: foo [FLAGGA]…
416 -a, --flagga en flagga
417 -b, --annan-flagga[=VÄRDE]
420 --help visa denna hjälp och avsluta
421 --version mata ut versionsinformation och avsluta
425 foo --flagga samma sak, men ange `--flagga'
427 Rapportera fel till <bug-gnu-utils@gnu.org>.
429 ‘help2man’ kommer att producera ‘nroff’-indata för en manualsida som
430 kommer att formateras enligt något som liknar:
432 FOO(1) Användarkommandon FOO(1)
435 foo - manualsida för foo 1.1
441 GNU ”foo” gör ingenting intressant förutom att fungera som exempel
448 -b, --annan-flagga[=VÄRDE]
451 --help visar denna hjälptext och avslutar
454 skriv ut versionsinformation och avsluta
460 samma sak, anger ”--flagga”
463 Skrivet av E. N. Programmerare.
466 Rapportera fel till <bug-gnu-utils@gnu.org>.
469 Copyright © 2011 Free Software Foundation, Inc.
470 This is free software; see the source for copying conditions.
471 There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A
475 Den fullständiga dokumentationen för foo upprätthålls som en Texinfo-manual.
476 Om programmen info och foo är korrekt installerade hos dig,
481 ge dig tillgång till den fullständiga manualen.
483 foo 1.1 Maj 2011 FOO(1)
486 File: help2man-sv.info.tmp, Node: Rapportering, Next: Tillgänglighet, Prev: Exempel, Up: Top
488 8 Rapportera fel eller förslag
489 ******************************
491 Om du hittar problem eller har förslag om detta program eller denna
492 manual, rapportera dem till <bug-help2man@gnu.org>.
494 Not till översättare: Översättningar hanteras via Translation Project
495 (http://translationproject.org/) se
496 <http://translationproject.org/html/translators.html> för vidare
500 File: help2man-sv.info.tmp, Node: Tillgänglighet, Prev: Rapportering, Up: Top
502 9 Få tag i ‘help2man’
503 *********************
505 Den senaste versionen av denna distribution är tillgänglig på nätet från
508 <http://ftpmirror.gnu.org/help2man/>
510 Om automatisk omdirigering misslyckas så finns listan över speglar
513 <http://www.gnu.org/order/ftp.html>
515 Eller om det behövs så kan du använda GNU:s huvudsakliga ftp-server:
516 <http://ftp.gnu.org/gnu/help2man/>
521 Node: Översikt
\7f2131
522 Node: Anropa help2man
\7f2886
523 Node: --help-rekommendationer
\7f5733
524 Node: Inkludera text
\7f9925
525 Node: Användning av Makefiler
\7f12061
526 Node: Lokaliserade manualsidor
\7f13076
527 Node: Exempel
\7f15116
528 Node: Rapportering
\7f17912
529 Node: Tillgänglighet
\7f18389