これは、Ubuntu Online、Fedora Online、Windows オンライン エミュレーター、MAC OS オンライン エミュレーターなど、複数の無料オンライン ワークステーションのいずれかを使用して、OnWorks 無料ホスティング プロバイダーで実行できるコマンド cli-generate です。
プログラム:
NAME
cli-generate - CLI の説明からソースとドキュメントを生成します
SYNOPSIS
cli 生成 [ -c | -h | -m | -w ] ファイル名.cli
DESCRIPTION
操作
cli 生成 CLI (コマンド ライン インターフェイス) 記述ファイルを読み取り、それを解析して
さまざまなセクションを表示し、一連の出力ファイルの XNUMX つを出力します。 通常の使用法では、
出力はファイルに送信され、後でコンパイルされるか、他のソースに含まれます。
CLI ファイル (名前は プログラム.cli) は XNUMX つの部分に分かれています。
標準のメールヘッダー) と一連のセクションです。 ヘッダーとそれ以外のセクション
以下に指定されているものは無視されます。 すべてのヘッダーとセクションはオプションです。
File フォーマット
file = ヘッダー "\n" *セクション
header = *(ヘッダー行 "\n")
ヘッダー行 = ヘッダー フィールド ":" 空白値
空白 = *(SPACE / TAB)
section = "[" 名前 "]" "\n" 行
lines = *( line "\n" )
ヘッダ
説明:
プログラムの動作を XNUMX 行で説明します。
含めます:
C ステートメントを追加して、指定されたソース ファイルを #include します。 次のいずれかの形式にする必要があります
or file
Min: 許可される非オプション引数の最小数。 デフォルトは 0 です。
最大: オプション以外の引数の許容最大数。 負の値の意味
無制限。 デフォルトは -1 です。
ショーピッド:
結果のプログラムがすべての出力でその PID を表示する場合は、ゼロ以外に設定します。
メッセージ。 デフォルトは 0 です。
使用法: 使用目的の XNUMX 行の説明。 デフォルトは空です。
セクション 名
[接頭語]
このセクションのテキストは、オプションの前のコマンドの使用法に示されています
説明。
[オプション]
このプログラムが受け入れるオプションのリスト。 それらの形式については、以下を参照してください。
[サフィックス]
このセクションのテキストは、オプションの後のコマンドの使用法に示されています
説明。
[説明]
[戻る 価値]
[エラー]
【例】
[環境]
[ファイル]
[見る また]
[ノート]
【注意事項】
【診断】
【バグ】
[制限]
[著者]
[歴史]
これらのセクションはフォーマットされ、標準の順序で man ページにコピーされます。
オプション フォーマット
options = *(オプション / セパレーター)
オプション = オプション 1 "\n" オプション 2 "\n" *(行 "\n")
option1 = [shortopt] [longopt] タイプ ["=" flag-value] 変数 ["=" init]
option2 = helpstr ["="デフォルト]
セパレーター = "-- " テキスト "\n"
shortopt = "-" 文字
longopt = "--" ワード
type = "FLAG" / "COUNTER" / "INTEGER" / "UINTEGER" / "STRING" / "STRINGLIST" / "FUNCTION"
指定されていない場合、 フラグ値 と INIT 0, デフォルト 空です。
書式設定
を除いて [接頭語], [オプション], [サフィックス]、すべてのセクションで書式設定がサポートされています
命令は TeXinfo の命令に似ています (ただし大幅に簡略化されています)。
@strong{テキスト}
「強い」(太字) テキストを使用します。
@コマンド{テキスト}
コマンドの名前を示します。
@option{テキスト}
コマンドライン オプションを示します。
@emph{テキスト}
「強調」(イタリック体) のテキストを使用します。
@var{テキスト}
メタ構文変数を示します。
@env{テキスト}
環境変数を示します。
@ファイル{テキスト}
ファイルの名前を示します。
@コード{テキスト}
プログラムの一部の文字通りの例であるテキストを示します。
@サンプル{テキスト}
一連の文字の文字通りの例であるテキストを示します。
@例
@終わり 例
これら XNUMX つのタグの間のテキストはインデントされます。
@逐語的に
@終わり 逐語的
これら XNUMX つのタグの間にあるものはすべてそのまま (逐語的に) 出力に渡されます。
@テーブル @フォーマット
@終わり テーブル
XNUMX 列の表、または「定義リスト」をマークアップします。
@アイテム 段落
テーブルに項目を追加します。 の @アイテム 実際のリストとなる段落を開始します
エントリ。 後続の段落は個別にタイプセットされます。
OPTIONS
-c Cソースコードを出力します。
-h C ヘッダー ファイルを出力します。
-m UNIX man ページを出力します。
-w HTML(Web)マークアップを出力します。
例
説明した要素の多くを含むサンプル CLI ファイルを次に示します。
最小:1
最大:1
使用法: パス
説明: ファイルを作成します。
ショーピッド: 0
含む:
[接頭語]
指定された PATH がディレクトリの場合、別の名前が接尾辞として付けられます。
[説明]
@program は、さまざまなソースから新しいランダム ファイルを生成します。
@command{ls} と @command{ps} の出力。
指定された @option{PATH} がディレクトリの場合、別の接尾辞が付けられます
私が選んだ名前。
[オプション]
-v --verbose FLAG=1 opt_verbose
-t --type STRING opt_type = "type1"
生成するファイルのタイプ。 = タイプ1
これに使用できるタイプには、@option{type1} および @option{base64} が含まれます。
onworks.net サービスを使用してオンラインで cli-generate を使用する