コマンド
statements-manager の実行は次のように行います。
$ ss-manager COMMAND [OPTIONS] [ARGS]
使用できるコマンド COMMAND は以下のとおりです。
run
usage: ss-manager run [-h] [-o {html, md, pdf}] [-p] [-f] [-c] [working_dir]
用意した Markdown ファイルを読み込み、指定された形式の出力ファイルを作成します。また、制約ファイルを出力する設定になっているときは、制約ファイルも出力します。
オプション
- working_dir
問題文の生成対象となるディレクトリを指定します。何も指定しない場合、コマンドが実行された階層を指定したとみなします。
working_dir以下を再帰的に探索し、見つかったproblem.tomlそれぞれについて問題文の生成が行われます。ただし-pがついているときは、問題セットにあるすべての問題に対して問題文の生成が行われることがあります。詳しくは-pの説明を参照してください。
- -o, --output
出力ファイルの形式を指定します。オプジョンに続けて
html,md,pdfのいずれかを指定します。このオプションが指定されていない場合、
htmlが指定されているとみなして実行されます。
- -p, --make-problemset
問題セットのファイルも出力します。出力形式は
-o, --outputオプションで指定されたものに従います。Tip
working_dirの祖先にあるproblemset.tomlのうち、最もworking_dirに近いものを読み込みます。また、
-pがついていてproblemset.tomlが存在するときは、problemset.tomlが存在するディレクトリの子孫にあるすべての問題に対して問題文の生成が行われます。
- -f, --force-dump
キャッシュファイルの情報を無視し、常に出力ファイルを更新します。
このオプションが付いておらず、既に存在する出力ファイルから内容が変化していない場合は、出力ファイルは更新されません。
Tip
statements-manager を実行すると、出力ファイルのバージョンを管理するためのファイル
cache.jsonも出力されます。通常、このファイルに書かれているハッシュ値と一致するときはファイルの更新を行いません。
- -c, --constraints-only
制約ファイルのみを更新します。このオプションを付けた場合、問題文の出力ファイルは更新されません。
- -h, --help
ヘルプメッセージを出力します。
実行例
次のコマンドを考えます。
$ ss-manager run ./problems -o pdf
このコマンドは次のように実行されます。
./problems以下にある問題文を対象として出力ファイルを作成するPDF 形式で出力する
出力ファイルの内容に変化がなければファイルを更新しない
reg-creds
usage: ss-manager reg-creds [-h] [creds_path]
Google Docs の API credentials を登録します。詳しい登録方法は Google Docs API を使用可能にする をご覧ください。
警告
Google Docs にある問題文を扱いたい場合は、このコマンドによる API credential の登録が必須となります。 問題文がすべてローカル環境に存在する場合はこの操作は不要です。