help2man - Trực tuyến trên đám mây

CHƯƠNG TRÌNH:

TÊN

help2man - tạo một trang thủ công đơn giản

SYNOPSIS

trợ giúp2man [TÙY CHỌN] ... CÓ THỂ THỰC HIỆN

MÔ TẢ

`help2man 'tạo ra một man page từ đầu ra` --help' và `--version '.

-n, --Tên=STRING
mô tả cho đoạn NAME

-s, --phần=PHẦN
số phần cho trang hướng dẫn sử dụng (1, 6, 8)

-m, --thủ công=TEXT
tên sách hướng dẫn (Lệnh người dùng, ...)

-S, --nguồn=TEXT
nguồn chương trình (FSF, Debian, ...)

-L, --ngôn ngữ=STRING
chọn ngôn ngữ (mặc định "C")

-i, --bao gồm=FILE
bao gồm tài liệu từ `FILE '

-I, --opt-bao gồm=FILE
bao gồm tài liệu từ `FILE 'nếu nó tồn tại

-o, - đầu ra=FILE
gửi đầu ra tới `FILE '

-p, --info-trang=TEXT
tên của sách hướng dẫn Texinfo

-N, --không có thông tin
ngăn chặn con trỏ đến hướng dẫn sử dụng Texinfo

-l, --libtool
loại trừ `` lt- '' khỏi tên chương trình

--Cứu giúp in trợ giúp này, sau đó thoát

--phiên bản
in số phiên bản, sau đó thoát

EXECUTABLE nên chấp nhận các tùy chọn `--help 'và` --version' và tạo ra đầu ra trên stdout
mặc dù các lựa chọn thay thế có thể được chỉ định bằng cách sử dụng:

-h, --tùy chọn trợ giúp=STRING
chuỗi tùy chọn trợ giúp

-v, --tùy chọn phiên bản=STRING
chuỗi tùy chọn phiên bản

- chuỗi-phiên bản=STRING
chuỗi phiên bản

--no-discard-stderr
bao gồm stderr khi phân tích cú pháp đầu ra tùy chọn

BAO GỒM CÁC TẬP TIN

Vật liệu bổ sung có thể được bao gồm trong đầu ra được tạo với --bao gồm và
--opt-bao gồm tùy chọn. Định dạng rất đơn giản:

[phần]
văn bản

/mẫu/
văn bản

Các khối văn bản roff nguyên văn * được chèn vào đầu ra ở đầu
được [phần] (không phân biệt chữ hoa chữ thường) hoặc sau khi đối sánh đoạn văn /Belt Hold/.

Các mẫu sử dụng cú pháp biểu thức chính quy Perl và có thể được theo sau bởi i, s or m
bổ ngữ (xem xin lỗi(1)).

Các dòng trước phần đầu tiên hoặc mẫu bắt đầu bằng dấu `- 'được xử lý dưới dạng tùy chọn.
Bất kỳ thứ gì khác sẽ bị bỏ qua một cách im lặng và có thể được sử dụng cho các nhận xét, từ khóa RCS và những thứ tương tự.

Thứ tự đầu ra của phần (đối với những phần được bao gồm) là:

TÊN
SYNOPSIS
MÔ TẢ
LỰA CHỌN
MÔI TRƯỜNG
CÁC TẬP TIN
VÍ DỤ
khác
TÁC GIẢ
BÁO CÁO
BẢN QUYỀN
XEM THÊM

Bất kì [TÊN] or [TÓM TẮC] các phần xuất hiện trong tệp bao gồm sẽ thay thế những gì sẽ
đã tự động được tạo (mặc dù bạn vẫn có thể ghi đè trước đó bằng --Tên
nếu được yêu cầu).

Các phần khác được thêm trước vào đầu ra được sản xuất tự động cho tiêu chuẩn
các phần được đưa ra ở trên, hoặc được bao gồm tại khác (ở trên) theo thứ tự mà họ đã gặp trong
tệp bao gồm.

Vị trí của văn bản trong phần có thể được yêu cầu rõ ràng bằng cách sử dụng cú pháp
[<phần], [=phần] hoặc [>phần] để đặt văn bản bổ sung trước, thay cho hoặc
sau đầu ra mặc định tương ứng.

KHẢ DỤNG

Phiên bản mới nhất của phân phối này có sẵn trực tuyến từ:

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

Sử dụng help2man trực tuyến bằng các dịch vụ onworks.net