diff options
author | Luke Shumaker <LukeShu@sbcglobal.net> | 2014-02-02 00:06:11 -0500 |
---|---|---|
committer | Luke Shumaker <LukeShu@sbcglobal.net> | 2014-02-02 00:06:11 -0500 |
commit | 001ab1a91d1182d7023329bd2342dbf6ec265554 (patch) | |
tree | 2eefe366e69e9a196d95f60c6adcf8a66b960a21 /HACKING.md | |
parent | ea11eca851e1b54e36d310f4d69e099f169191e8 (diff) |
Hacking.md: change formatting on sample output a bit
Diffstat (limited to 'HACKING.md')
-rw-r--r-- | HACKING.md | 10 |
1 files changed, 5 insertions, 5 deletions
@@ -51,13 +51,13 @@ lines that should not wrap, `echo` to print blank lines, `prose` to print paragraphs, `bullet` to print bullet points, and `flag` to print option flags. The text should follow this general format: - print |Usage: ${program} [OPTIONS] VARS_ARE_UNDERSCORE_AND_CAPITAL - print |One line description of program, no period + print "Usage: %s [OPTIONS] VARS_ARE_UNDERSCORE_AND_CAPITAL" "${program_name}" + print "One line description of program, no period" echo - prose |More details. This is a paragraph. + prose "More details. This is a paragraph." echo - print |Options: - flag | -h Show this message + print "Options:" + flag "-h" "Show this message" In the "Usage:" line, use printf `%s` and the value `"${0##*/}"` to determine the program name at runtime. |