README.md templete (like man page)

example.markdown

BOSHIN

スクショを撮影してタイトルバーとかをトリミングしてくれるやつ

SYNOPSIS

boshin [-vh] [-i input_file] [output_path]

DESCRIPTION

iTerm等のスクリーンショットを普通に撮るとウィンドウバーまで写ってしまって邪魔です。このスクリプトは撮影したスクリーンショットをImageMagickでステータスバーを取り除いた上でカレントディレクトリに出力します。

このスクリプトは正常終了時、自身の後ろにパイプが接続されている場合は、加工し出力したスクリーンショットのファイルパスを標準出力します。パイプがない場合は標準出力しません。

USAGE

1. ターミナル等からboshinを呼び出します

   $ boshin

2. ウィンドウ選択モードになるので、撮影したウィンドウをクリックします

3. カレントディレクトリ（<Output Path>を指定した際は指定のパス）にスクリーンショットが保存されます

OPTIONS

• -v, --version
  • バージョンを標準エラー出力に表示し、正常終了します。
• -h, --help
  • ヘルプを標準エラー出力に表示し、正常終了します。
• -i PATH, --input PATH
  • 撮影したスクリーンショットではなく、既存の画像ファイルに対し加工を施したい際に使用します。

EXIT STATUS

	説明
0	正常終了
2	ImageMagickへのパスが通っていないか、存在しません
255	存在しないオプション、またはオプションの引数に不備があります

NOTES

• このスクリプトはMacでしか動作しません
• 動作にはImageMagickが必要です

EXAMPLE

• 出力先を指定して実行

  $ boshin ./ss.png

• 既存のスクリーンショットに対して実行

  $ boshin --input ~/Pictures/screenshots/old.png ./new.png

• 撮影した結果をすぐに確認する

  $ boshin | xargs open

SEE ALSO

target(3), capture(6), bodysensor(4)

AUTHORS

Masaya Tk (https://github.com/844196)

templete.markdown

TITLE

SYNOPSIS

DESCRIPTION

USAGE

OPTIONS

EXIT STATUS

NOTES

EXAMPLE

AUTHORS