HELP2MAN(1)

TÊN
help2man - tạo một trang hướng dẫn đơn giản

MÔ TẢ
`help2man' generates a man page out of `--help' and `--version' output.

Usage: help2man [OPTION]... EXECUTABLE

-n, --name=STRING
    description for the NAME paragraph

-s, --section=SECTION
    section number for manual page (1, 6, 8)

-m, --manual=TEXT
    name of manual (User Commands, ...)

-S, --source=TEXT
    source of program (FSF, Debian, ...)

-L, --locale=STRING
    select locale (default "C")

-i, --include=FILE
    include material from `FILE'

-I, --opt-include=FILE
    include material from `FILE' if it exists

-o, --output=FILE
    send output to `FILE'

-p, --info-page=TEXT
    name of Texinfo manual

-N, --no-info
    suppress pointer to Texinfo manual

-l, --libtool
    exclude the `lt-' from the program name

--help
    print this help, then exit

--version
    print version number, then exit

EXECUTABLE should accept `--help' and `--version' options and produce output on stdout although alternatives may be specified using:

-h, --help-option=STRING
    help option string

-v, --version-option=STRING
    version option string

--version-string=STRING
    version string

--no-discard-stderr
    include stderr when parsing option output

Report bugs to <bug-help2man@gnu.org>.

TỆP BAO GỒM
Cũng có thể bao gồm dữ liệu bổ sung trong kết xuất, dùng tuỳ chọn --include và --opt-include Có một định dạng đơn giản:
    [phần]
    chuỗi
    /mẫu/
    chuỗi Khối văn bản định dạng *roff đúng nguyên văn được chèn vào kết xuất hoặc ở đầu của phần [phần] (không phân biệt chữ hoa/thường), hoặc đẳng sau một đoạn văn tương ứng với mẫu /mẫu/. Mẫu chấp nhận cú pháp của biểu thức chính quy Perl, và cũng cho phép dấu sửa đổi i, s hay m (xem perlre(1)). Dòng nào đẳng trước phần đầu tiên hoặc mẫu bắt đầu với « - » thì được xử lý dưới dạng tuỳ chọn. Dữ liệu khác (nếu có) bị bỏ qua mà không xuất chi tiết, và có thể được sử dụng làm ghi chú, từ khoá RCS v.v. Thứ tự xuất phần (đã bao gồm):
    TÊN
    TÓM TẮT
    MÔ TẢ
    TÙY CHỌN
    MÔI TRƯỜNG
    TỆP
    VÍ DỤ
    khác
    TÁC GIẢ
    THÔNG BÁO LỖI
    BẢN QUYỀN
    XEM THÊM Bắt cứ phần [NAME] hoặc [SYNOPSIS] nào xuất hiện trong tập tin bao gồm thì thay thế kết xuất tự động tạo (dù bạn vẫn còn có dịp ghi đè lên phần [NAME] bằng: --name nếu cần). NAME: TÊN SYNOPSIS: TÓM TẮT Các phần khác được thêm vào đầu của kết xuất tự động tạo cho những phần tiêu chuẩn đưa ra trên, hoặc được bao gồm tại other (bên trên) theo thứ tự gặp trong tập tin bao gồm.

TÍNH SẴN SÀNG
Phiên bản mới nhất của bản phân phối này có sẵn sàng trực tuyến từ :
    ftp://ftp.gnu.org/gnu/help2man/

BẢN QUYỀN
Copyright © 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011 Free Software Foundation, Inc. This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Written by Brendan O'Dea <bod@debian.org>

XEM THÊM
Tài liệu hướng dẫn đầy đủ về help2man được bảo tồn dưới dạng một sổ tay Texinfo. Nếu chương trình info và help2man được cài đặt đúng ở địa chỉ của bạn thì câu lệnh

    info help2man

nên cho phép bạn truy cập đến sổ tay hoàn toàn.