1 This is help2man-ro.info.tmp, produced by makeinfo version 6.8 from
4 Acest fișier documentează comanda GNU ‘help2man’ care produce pagini de
5 manual simple din ieșirea ‘--help’ și ‘--version’ ale altor comenzi.
7 Drepturi de autor © 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009,
8 2010, 2011, 2012, 2013, 2014, 2015, 2020, 2021 Free Software Foundation,
11 Se acordă permisiunea de a face și de a distribui copii textuale ale
12 acestui manual, cu condiția ca notificarea privind drepturile de autor
13 și această notificare de permisiune să fie păstrate pe toate copiile.
15 Se acordă permisiunea de a copia și distribui versiunile modificate
16 ale acestui manual în condițiile copierii textuale, cu condiția ca
17 întreaga lucrare derivată rezultată să fie distribuită în condițiile
18 unei notificări de permisiune identice cu aceasta.
20 Se acordă permisiunea de a copia și distribui traduceri ale acestui
21 manual într-o altă limbă, în condițiile de mai sus pentru versiunile
22 modificate, cu excepția faptului că această notificare de permisiune
23 poate fi menționată într-o traducere aprobată de Fundație.
24 INFO-DIR-SECTION Dezvoltare de software
26 * help2man-ro: (help2man-ro). Generare automată a paginii de manual.
30 File: help2man-ro.info.tmp, Node: Top, Next: Prezentare generală, Up: (dir)
35 ‘help2man’ produce pagini de manual simple din ieșirea ‘--help’ și
36 ‘--version’ ale altor comenzi.
40 * Prezentare generală:: Prezentare generală
42 * Invocarea help2man:: Cum să rulați ‘help2man’.
43 * Recomandări pentru opțiunea „--help”:: Recommended formatting
45 * Includere de text:: Includerea unui text
46 suplimentar în rezultat.
47 * Utilizarea fișierului „Makefile”:: Utilizarea lui ‘help2man’cu
49 * Pagini de manual traduse:: Producerea paginilor de
50 manual în limbamaternă.
51 * Exemplu:: Exemplu de ieșire al
53 * Rapoarte:: Raportare erori sau sugestii.
54 * Disponibilitate:: Obținere ‘help2man’.
57 File: help2man-ro.info.tmp, Node: Prezentare generală, Next: Invocarea help2man, Prev: Top, Up: Top
59 1 Prezentare generală a ‘help2man’
60 **********************************
62 ‘help2man’ este un instrument pentru generarea automată a paginilor de
63 manual simple din ieșirea programului.
65 Deși paginile de manual sunt opționale pentru programele GNU, alte
66 proiecte, cum ar fi Debian, le solicită (*note (standarde)Pagini de
69 Acest program este menit să ofere o modalitate ușoară pentru autorii
70 de software de a include o pagină de manual în distribuția lor fără a fi
71 nevoiți să mențină acel document.
73 Având în vedere un program care produce ieșiri ‘--help’ și
74 ‘--version’ destul de standard, ‘help2man’ poate rearanja acea ieșire în
75 ceva care seamănă cu o pagină de manual.
78 File: help2man-ro.info.tmp, Node: Invocarea help2man, Next: Recomandări pentru opțiunea „--help”, Prev: Prezentare generală, Up: Top
80 2 Cum să rulați ‘help2man’
81 **************************
83 Formatul pentru rularea programului ‘help2man’ este:
85 help2man [OPȚIUNE]... EXECUTABIL
87 ‘help2man’ suportă următoarele opțiuni:
91 Utilizează ȘIR ca descriere pentru paragraful ‘NUME’ din pagina
94 În mod implicit (în lipsă de ceva mai bun), acest paragraf conține
95 ‘pagina de manual pentru PROGRAM VERSIUNEA’.
97 Această opțiune suprascrie o secțiune a fișierului de includere
98 ‘[nume]’ (*note Includere de text::).
102 Utilizează SECȚIUNE ca secțiune pentru pagina de manual. Secțiunea
107 Stabilește numele secțiunii de manual la SECȚIUNE, folosit ca titlu
108 centrat pentru pagina de manual. În mod implicit, ‘Comenzile
109 utilizatorului’ este utilizat pentru paginile din secțiunea 1,
110 ‘Jocuri’ pentru secțiunea 6 și ‘Utilități de administrare a
111 sistemului’ pentru secțiunile 8 și 1M.
115 Sursa programului este folosită ca subsol de pagină și adesea
116 conține numele organizației sau o suită din care programul face
117 parte. În mod implicit, valoarea este numele și versiunea
121 ‘--locale=LOCALIZARE’
122 Selectează localizarea de ieșire (implicit ‘C’). Atât programul,
123 cât și ‘help2man’ trebuie să accepte LOCALIZARE (*note Pagini de
128 Include material din FIȘIER (*note Includere de text::).
131 ‘--opt-include=FIȘIER’
132 O variantă a ‘--include’ pentru utilizare în regulile de model
133 Makefile care nu necesită ca FIȘIER să existe.
137 Trimite ieșirea la FIȘIER și nu la ‘ieșirea_standard’.
141 Numele manualului Texinfo.
145 Suprimă includerea unui paragraf ‘CONSULTAȚI DE ASEMENEA’ care
146 direcționează cititorul către documentația Texinfo.
150 Elimină prefixul ‘lt-’ din instanțe ale numelui programului din
151 rezumat (‘libtool’ creează scripturi de shell în directorul de
152 compilare care invocă ‘foo’ ca ‘.libs/lt-foo’).
156 Afișează informații despre ajutor sau despre versiune.
158 În mod implicit, ‘help2man’ pasează opțiunile standard ‘--help’ și
159 ‘--version’ executabilului, dar se pot specifica opțiuni alternative
163 ‘--help-option=OPȚIUNE’
164 Șir pentru opțiunea de ajutor.
167 ‘--version-option=OPȚIUNE’
168 Șir pentru opțiunea de versiune.
170 ‘--version-string=ȘIR’
173 ‘--no-discard-stderr’
174 Include ieșirea de eroare standard atunci când analizează
178 File: help2man-ro.info.tmp, Node: Recomandări pentru opțiunea „--help”, Next: Includere de text, Prev: Invocarea help2man, Up: Top
180 3 Recomandări pentru „‘--help’”
181 *******************************
183 Iată câteva recomandări despre ce să includeți în rezultatul dvs.
184 „‘--help’”. Includerea acestora îi oferă lui ‘help2man’ cea mai bună
185 șansă de a genera o pagină de manual respectabilă, precum și de a
186 beneficia direct utilizatorii.
188 Consultați *note (standarde)Interfețe de linie de comandă:: și *note
189 (standarde)Pagini de manual::, pentru standardele oficiale GNU
190 referitoare la ‘--help’ și paginile de manual .
192 • Un rezumat al modului de invocare a programului. Dacă utilizări
193 diferite ale programului au invocări diferite, atunci enumerați-le
194 pe toate. De exemplu (editat pentru concizie):
196 Utilizare: cp [OPȚIUNE]... SURSA DESTINAȚIE
197 sau: cp [OPȚIUNE]... SURSĂ... DIRECTOR
200 Utilizați ‘argv[0]’ pentru numele programului din aceste rezumate,
201 așa cum este, fără eliminarea directorului. Acest lucru este în
202 contrast cu numele canonic (constant) al programului care este
203 folosit în „‘--version’”.
205 • O explicație foarte scurtă despre ceea ce face programul, inclusiv
206 comportamentul implicit și/sau tipic. De exemplu, aici este ‘cp’:
208 Copiază SURSĂ în DESTINAȚIE sau mai multe SURSE în DIRECTOR.
210 • O listă de opțiuni, indentată în coloana 2. Dacă programul acceptă
211 opțiuni cu un singur caracter, puneți-le primele, apoi opțiunile
212 lungi echivalente (dacă există). Dacă opțiunea preia un argument,
213 includeți-l și pe acesta, dându-i un nume semnificativ. Aliniați
214 descrierile într-o coloană convenabilă, dacă doriți. Rețineți că
215 pentru a fi recunoscută corect de ‘help2man’ descrierea trebuie să
216 fie separată de opțiuni cu cel puțin două spații, iar descrierile
217 continuate pe rândurile următoare trebuie să înceapă în aceeași
220 Iată din nou un extras (editat) din ‘cp’, care arată o opțiune
221 scurtă cu o opțiune lungă echivalentă, doar o opțiune lungă și doar
224 -a, --archive la fel ca -d, -p, -R
225 --backup[=CONTROL] face o copie de rezervă pentru fiecare ...
226 -b precum --backup dar ...
228 Pentru programele care au multe opțiuni, poate fi de dorit să
229 împărțiți lista de opțiuni în secțiuni precum ‘Global’, ‘Controlul
230 ieșirii’ sau orice are sens în cazul particular. De obicei, cel
231 mai bine este să alfabetizați (întâi după numele scurt al opțiunii,
232 apoi lung) în fiecare secțiune sau întreaga listă dacă nu există
235 • Orice informații suplimentare utile despre comportamentul
236 programului, cum ar fi variabilele de mediu influente, explicațiile
237 suplimentare ale opțiunilor etc. De exemplu, pentru ‘cp’, puteți
238 introduce date pentru variabila de mediu ‘VERSION_CONTROL’ și
241 • Câteva exemple de utilizare tipică, la discreția dumneavoastră. Un
242 exemplu bun merită, de obicei, mai mult de o mie de cuvinte de
243 descriere, așa că acesta este foarte recomandat.
245 • În încheiere, o linie care indică cum să trimiți prin e-mail
246 rapoartele de eroare. De obicei, ADRESA DE EMAIL va fi
247 ‘bug-PROGRAM@gnu.org’; utilizați acest format pentru programele GNU
248 ori de câte ori este posibil. De asemenea, este bine să menționați
249 pagina principală a programului, alte liste de corespondență etc.
251 Interfețele de programare ‘argp’ și ‘popt’ vă permit să specificați
252 descrieri ale opțiunilor pentru ‘--help’ în aceeași structură ca și
253 restul definiției opțiunii; poate doriți să luați în considerare
254 utilizarea acestor rutine pentru analizarea opțiunilor în loc de
257 În mod implicit, ‘help2man’ are unele euristici pentru identificarea
258 secțiunilor de pagină de manual: o linie constând din ‘Opțiuni:’, de
259 exemplu, va face ca următorul text să apară în secțiunea ‘OPȚIUNI’ și o
260 linie care începe cu ‘Copyright’ va apărea în secțiunea ‘COPYRIGHT’. În
261 afara acestor euristici, o linie constând din ‘*Cuvinte*’ va începe o
262 nouă secțiune, iar ‘Cuvinte:’ o nouă sub-secțiune.
265 File: help2man-ro.info.tmp, Node: Includere de text, Next: Utilizarea fișierului „Makefile”, Prev: Recomandări pentru opțiunea „--help”, Up: Top
267 4 Includerea textului suplimentar în ieșire
268 *******************************************
270 Text static suplimentar poate fi inclus în pagina de manual generată
271 utilizând opțiunile ‘--include’ și ‘--opt-include’ (*note Invocarea
272 help2man::). Deși aceste fișiere pot fi „botezate” cu orice nume,
273 pentru coerență vă sugerăm să utilizați extensia ‘.h2m’ pentru fișierele
274 de includere ‘help2man’.
276 Formatul pentru fișierele incluse în această opțiune este simplu:
284 Blocurile de text *roff textual sunt inserate în ieșire fie la
285 începutul ‘[secțiune]’ date (fără să facă distincție între majuscule și
286 minuscule), fie după un paragraf ce corespunde cu un ‘/model/’.
288 Modelele folosesc sintaxa expresiei regulate Perl și pot fi urmate de
289 modificatorii ‘i’, ‘s’ sau ‘m’ (*note perlre(1): (*manpages*)perlre.)
291 Liniile dinaintea primei secțiuni sau model care încep cu ‘-’ sunt
292 procesate ca opțiuni. Orice altceva este ignorat în tăcere și poate fi
293 folosit pentru comentarii, cuvinte cheie RCS și altele asemenea.
295 Ordinea de ieșire a secțiunii (pentru cele incluse) este:
308 CONSULTAȚI DE ASEMENEA
310 Orice secțiune ‘[nume]’ sau ‘[rezumat’ care apare în fișierul de
311 includere va înlocui ceea ce ar fi fost produs automat (dar puteți
312 suprascrie pe prima dintre aceste secțiuni cu opțiunea ‘--name’ dacă
315 Alte secțiuni sunt adăugate la ieșirea produsă automat pentru
316 secțiunile standard prezentate mai sus sau incluse la _altele_ (mai sus)
317 în ordinea în care au fost întâlnite în fișierul include.
319 Plasarea textului în secțiune poate fi solicitată în mod explicit
320 utilizând sintaxa ‘[<section]’, ‘[=section]’ sau ‘[>section]’ pentru a
321 plasa textul suplimentar înainte de, în loc de sau după ieșirea
325 File: help2man-ro.info.tmp, Node: Utilizarea fișierului „Makefile”, Next: Pagini de manual traduse, Prev: Includere de text, Up: Top
327 5 Utilizarea ‘help2man’ cu ‘make’
328 *********************************
330 O utilizare sugerată a ‘help2man’ în Makefiles este ca pagina de manual
331 să nu depindă de binar, ci de fișierul(ele) sursă în care ieșirile
332 ‘--help’ și ‘--version’ sunt definite.
334 Această utilizare permite ca o pagină de manual să fie generată de
335 întreținător și inclusă în distribuție fără a fi necesar ca utilizatorul
336 final să aibă ‘help2man’ instalat.
338 Un exemplu de regulă pentru programul ‘prog’ ar putea fi:
340 prog.1: $(srcdir)/main.c
341 -$(HELP2MAN) --output=$@ --name='un program de exemplu' ./prog
343 Valoarea ‘HELP2MAN’ poate fi stabilită în ‘configure.in’ utilizând
344 oricare dintre următoarele:
346 AM_MISSING_PROG(HELP2MAN, help2man)
348 pentru ‘automake’ sau ceva de tipul:
350 AC_PATH_PROG(HELP2MAN, help2man, false // No help2man //)
352 pentru ‘autoconf’ doar.
355 File: help2man-ro.info.tmp, Node: Pagini de manual traduse, Next: Exemplu, Prev: Utilizarea fișierului „Makefile”, Up: Top
357 6 Producerea paginilor de manual în limba maternă
358 *************************************************
360 Paginile de manual pot fi produse pentru orice localizare suportată atât
361 de program, cât și de ‘help2man’ cu opțiunea ‘--locale’ (‘-L’).
363 help2man -L fr_FR@euro -o cp.fr.1 cp
365 Consultați <http://translationproject.org/domain/help2man.html>
366 pentru limbile acceptate în prezent de ‘help2man’ și *note Rapoarte::
367 pentru cum să trimiteți alte traduceri.
369 6.1 Modificarea locației cataloagelor de mesaje
370 ===============================================
372 Când se creează pagini de manual traduse din directorul de compilare al
373 unui program, este puțin probabil ca traducerile instalate în locația
374 standard (dacă programul este instalat) să fie corecte pentru versiunea
375 programului care este construit.
377 O bibliotecă preîncărcabilă este furnizată cu ‘help2man’ care va
378 intercepta apelurile ‘bindtextdomain’ care configurează locația
379 cataloagelor de mesaje pentru domeniul dat de ‘$TEXTDOMAIN’ și va
380 suprascrie locația către calea dată de ‘$LOCALEDIR’.
384 mkdir -p tmp/fr/LC_MESSAGES
385 cp po/fr.gmo tmp/fr/LC_MESSAGES/PROG.mo
386 LD_PRELOAD="/usr/lib/help2man/bindtextdomain.so" \
389 help2man -L fr_FR@euro -i PROG.fr.h2m -o PROG.fr.1 PROG
392 va face ca PROG să încarce catalogul de mesaje din ‘tmp’, mai degrabă
393 decât din ‘/usr/share/locale’.
396 • Generalizarea lui ‘fr_FR@euro’ la ‘fr’ în exemplul de mai sus este
397 realizată de ‘gettext’, dacă ar fi fost disponibilă o potrivire mai
398 specifică, ar fi fost utilizată, de asemenea.
400 • Această preîncărcare a fost testată numai pentru ‘eglibc’ 2.11.2 și
401 ‘gettext’ 0.18.1.1 pe un sistem GNU/Linux; anunțați-mă dacă
402 funcționează (sau nu) pentru dumneavoastră (*note Rapoarte::).
405 File: help2man-ro.info.tmp, Node: Exemplu, Next: Rapoarte, Prev: Pagini de manual traduse, Up: Top
407 7 Exemplu de ieșire ‘help2man’
408 ******************************
410 Având un program ipotetic ‘foo’ care produce următoarea ieșire:
415 Copyright (C) 2011 Free Software Foundation, Inc.
416 Acesta este software liber; consultați codul sursă pentru condițiile de copiere. NU există
417 nicio garanție; nici măcar pentru VANDABILITATE sau de POTRIVIRE PENTRU UN SCOP ANUME.
419 Scris de Un Programator.
421 GNU `foo' nu face nimic interesant decât să servească drept exemplu pentru
424 Utilizare: foo [OPȚIUNE]...
427 -a, --option o opțiune
428 -b, --another-option[=VALOARE]
431 --help afișează acest ajutor și iese
432 --version afișează informații despre versiune și iese
436 foo --option același lucru, specificând „--option”
438 Raportați erorile la <bug-gnu-utils@gnu.org>.
440 ‘help2man’ va produce intrare pentru ‘nroff’ pentru a crea o pagină
441 de manual care va fi formatată cam așa:
443 FOO(1) Comenzile utilizatorului FOO(1)
446 foo - pagina de manual pentru foo 1.1
452 GNU «foo» nu face nimic interesant decât să servească drept exemplu pentru
459 -b, --another-option[=VALOARE]
462 --help afișează acest ajutor și iese
465 afișează informații despre versiune și iese
471 același lucru, specificând „--option”
474 Scris de Un Programator.
477 Raportați erorile la <bug-gnu-utils@gnu.org>.
480 Copyright © 2011 Free Software Foundation, Inc.
481 Acesta este software liber; consultați codul sursă pentru condițiile de copiere.
482 NU există nicio garanție; nici măcar pentru VANDABILITATE sau de POTRIVIRE
483 PENTRU UN SCOP ANUME.
485 CONSULTAȚI DE ASEMENEA
486 Documentația completă pentru foo este menținută ca un manual Texinfo.
487 Dacă programele info și foo sunt instalate corect pe sistemul dumneavoastră,
492 ar trebui să vă ofere acces la manualul complet.
494 foo 1.1 Mar 2022 FOO(1)
497 File: help2man-ro.info.tmp, Node: Rapoarte, Next: Disponibilitate, Prev: Exemplu, Up: Top
499 8 Raportare erori sau sugestii
500 ******************************
502 Dacă găsiți probleme sau aveți sugestii despre acest program sau manual,
503 raportați-le la <bug-help2man@gnu.org>.
505 Notă pentru traducători: Traducerile sunt gestionate prin Translation
506 Project (http://translationproject.org/), consultați
507 <http://translationproject.org/html/translators.html> pentru detalii.
510 File: help2man-ro.info.tmp, Node: Disponibilitate, Prev: Rapoarte, Up: Top
512 9 Obținere ‘help2man’
513 *********************
515 Cea mai recentă versiune a acestei distribuții este disponibilă în
516 internet, din oglinzile GNU:
518 <http://ftpmirror.gnu.org/help2man/>
520 Dacă redirecționarea automată eșuează, lista oglinzilor este la:
522 <http://www.gnu.org/order/ftp.html>
524 Sau, dacă este necesar, puteți utiliza serverul principal GNU ftp:
525 <http://ftp.gnu.org/gnu/help2man/>
530 Node: Prezentare generală
\7f2331
531 Node: Invocarea help2man
\7f3174
532 Node: Recomandări pentru opțiunea „--help”
\7f6394
533 Node: Includere de text
\7f10959
534 Node: Utilizarea fișierului „Makefile”
\7f13205
535 Node: Pagini de manual traduse
\7f14293
536 Node: Exemplu
\7f16404
537 Node: Rapoarte
\7f19270
538 Node: Disponibilitate
\7f19749