HELP2MAN(1)

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

TÓM TẮT
help2man [TÙY_CHỌN]… TÊN-LỆNH

MÔ TẢ
“help2man” tạo một trang hướng dẫn dựa trên kết xuất từ tùy chọn “--help” (trợ giúp) và “--version” (phiên bản).

-n, --name=CHUỖI
    mô tả cho đoạn văn TÊN (NAME)

-s, --section=PHẦN
    số thứ tự phần cho trang hướng dẫn (1, 6, 8)

-m, --manual=TÊN
    tên của trang hướng dẫn (User Commands, …)

-S, --source=TEXT
    nguồn của chương trình (FSF, Debian, …)

-L, --locale=CHUỖI
    chọn miền địa phương (mặc định "C"; đối với tiếng Việt thì là “vi_VN.UTF-8”)

-i, --include=TỆP
    bao gồm dữ liệu từ tập tin này

-I, --opt-include=TỆP
    bao gồm dữ liệu từ tập tin này nếu có

-o, --output=TỆP
    gửi kết xuất cho tập tin này

-p, --info-page=TÊN
    tên của trang hướng dẫn loại Texinfo

-N, --no-info
    thu hồi cái chỉ tới trang hướng dẫn Texinfo

-l, --libtool
    loại trừ “lt-” từ tên của chương trình

--help
    hiển thị trợ giúp này, sau đó thoát

--version
    hiển thị số thứ tự phiên bản, sau đó thoát

TÊN-LỆNH có thể chấp nhận hai tùy chọn “--help” và “--version” và sản sinh kết xuất qua đầu ra tiêu chuẩn (stdout) mặc dù cũng có thể ghi rõ thêm tùy chọn:

-h, --help-option=CHUỖI
    chuỗi là tùy chọn trợ giúp

-v, --version-option=CHUỖI
    chuỗi là tùy chọn phiên bản

--version-string=CHUỖI
    chuỗi phiên bản

--no-discard-stderr
    bao gồm cả kết xuất từ đầu ra lỗi tiêu chuẩn khi phân tích cú pháp của kết xuất tùy chọn

Thông báo lỗi nào cho <bug-help2man@gnu.org>. Thông báo lỗi dịch cho <translation-team-vi@lists.sourceforge.net>.

Bản quyền (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2020, 2021, 2022 Tổ chức Phần mềm Tự do. Đây là phần mềm miễn phí; xem trong mã nguồn để biết các điều khoản về sao chép. Đây KHÔNG bảo hành; thậm chí còn có thể BÁN ĐƯỢC hay PHÙ HỢP VỚI MỤC ĐÍCH ĐẶC THÙ.

TẬP TIN BAO GỒM
Cũng có thể bao gồm dữ liệu bổ sung trong kết xuất, dùng tùy chọn --include và --opt-include Có một định dạng đơn giản:

    [phần]
    văn bản

    /mẫu/
    văn bản

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 tùy 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ừ khóa RCS và những thứ tương tự thế.

Thứ tự xuất phần (đã được bao gồm):

    TÊN
    TÓM TẮT
    MÔ TẢ
    TÙY CHỌN
    khác
    MÔI TRƯỜNG
    TẬP TIN
    VÍ DỤ
    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 tiền nhiệm 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 sản sinh cho những phần tiêu chuẩn đưa ra trên, hoặc được bao gồm tại khác (bên trên) theo thứ tự gặp trong tập tin bao gồm.

Thay thế phần chữ trong “phần” có thể yêu cầu rõ ràng bằng cách sử dụng cú pháp [<phần], [=phần] hay [>phần] bổ xung thêm chữ vào trước, thay thế vào chỗ đó, hay sau của kết xuất mặc định tương ứng.

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ó thể tải về từ:

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

TÁC GIẢ
Viết bởi Brendan O'Dea <bod@debian.org>

XEM THÊM
Tài liệu hướng dẫn đầy đủ về help2man được bảo trì 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 toàn bộ sổ tay.