NAME¶

help2man - δημιουργία απλής σελίδας εγχειριδίου

SYNOPSIS¶

help2man [OPTION]... EXECUTABLE

DESCRIPTION¶

`help2man' δημιουργεί μια σελίδα man από την έξοδο των `--help' και `--version' output.

-n, --name=STRING

περιγραφή για την παράγραφο NAME

-s, --section=SECTION

αριθμός ενότητας για σελίδα εγχειριδίου (1, 6, 8)

-m, --manual=TEXT

όνομα εγχειριδίου (Εντολές Χρήστη, ...)

-S, --source=TEXT

προέλευση προγράμματος (FSF, Debian, ...)

-L, --locale=STRING

επιλογή τοποθεσίας (προεπιλογή "C")

-i, --include=FILE

να συμπεριληφθεί υλικό από το `FILE'

-I, --opt-include=FILE

να συμπεριληφθεί υλικό από το `FILE' εάν υπάρχει

-o, --output=FILE

αποστολή αποτελέσματος σε `FILE'

-p, --info-page=TEXT

όνομα του εγχειριδίου Texinfo

-N, --no-info

καταστολή δείκτη σε εγχειρίδιο Texinfo

--help

εμφάνιση αυτής της βοήθειας, μετά έξοδος

--version

εμφάνιση αριθμού έκδοσης, μετά έξοδος

Το EXECUTABLE θα πρέπει να δέχεται επιλογές `--help' και `--version' και να παράγει αποτέλεσμα στην stdout παρόλο που μπορεί να ορισθούν εναλλακτικά με χρήση:

-h, --help-option=STRING

αλφαριθμητικό επιλογής βοήθεια

-v, --version-option=STRING

αλφαριθμητικό επιλογής έκδοσης

--version-string=STRING

αλφαριθμητικό έκδοσης

--no-discard-stderr

να συμπεριληφθεί το stderr κατά την ανάλυση του αποτελέσματος της επιλογής

Αναφέρετε σφάλματα σε <bug-help2man@gnu.org>.

INCLUDE FILES¶

Επιπλέον υλικό μπορεί να συμπεριληφθεί στο παραγόμενο αποτέλεσμα με --include και --opt-include ως επιλογές. Η μορφή είναι απλή:

[ενότητα]
κείμενο

/μοτίβο/
κείμενο

Μπλοκ αυτολεξί κειμένου *roff εισάγονται στο αποτέλεσμα είτε στην αρχή της δοσμένης [section] (προσοχή στα πεζά-κεφαλαία), ή μετά από μοτίβο παραγράφου /pattern/.

Τα μοτίβα χρησιμοποιούν το συντακτικό κανονικών εκφράσεων της Perl και μπορεί να ακολουθούνται από τους i, s or m τροποποιητές (δες perlre(1)).

Οι γραμμές πριν την πρώτη ενότητα ή μοτίβο που αρχίζουν με `-' αντιμετωπίζονται ως επιλογές. Οτιδήποτε άλλο αγνοείται σιωπηρά και μπορεί να χρησιμοποιηθεί για σχόλια, λέξεις κλειδιά RCS και παρόμοια.

Η σειρά εξαγωγής ενοτήτων (γι' αυτές που περιλαμβάνονται) είναι:

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
ENVIRONMENT
FILES
EXAMPLES
άλλο
AUTHOR
REPORTING BUGS
COPYRIGHT
SEE ALSO

Οποιεσδήποτε [NAME] ή [SYNOPSIS] ενότητες που εμφανίζονται στο αρχείο για να συμπεριληφθούν θα αντικαταστήσουν ό,τι θα είχε παραχθεί αυτόματα (παρόλο που μπορείτε ακόμα να παρακάμψετε την προηγούμενη με --name αν απαιτείται).

Άλλες ενότητες ενσωματώνονται στο αυτόματα παραγόμενο αποτέλεσμα για τις τυπικές ενότητες που δίνονται ανωτέρω, ή συμπεριλαμβάνονται στο other (ανωτέρω) με τη σειρά που είχαν στο αρχείο για να συμπεριληφθούν.

AVAILABILITY¶

Η τελευταία έκδοση αυτής της διανομή είναι διαθέσιμη διαδικτυακά από:

ftp://ftp.gnu.org/gnu/help2man/

COPYRIGHT¶

Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012 Free Software Foundation, Inc. Αυτό είναι ελεύθερο λογισμικό. Δείτε τον πηγαίο κώδικα για όρους αντιγραφής. ΔΕΝ δίδεται εγγύηση, ούτε ακόμα ΕΜΠΟΡΕΥΣΙΜΟΤΗΤΑΣ ή ΚΑΤΑΛΛΗΛΟΤΗΤΑΣ ΓΙΑ ΣΥΓΚΕΚΡΙΜΕΝΟ ΣΚΟΠΟ.

Συγγραφή: Brendan O'Dea <bod@debian.org>

SEE ALSO¶

Η πλήρης τεκμηρίωση για help2man υπάρχει ως εγχειρίδιο Texinfo. Αν το info και help2man τα προγράμματα έχουν εγκατασταθεί σωστά στη σελίδα σας, η εντολή

info help2man

θα πρέπει να σας δίνει πρόσβαση στο πλήρες εγχειρίδιο.