From 542776fd2ec812baad8e1365382338166b9b6c62 Mon Sep 17 00:00:00 2001 From: hacksalot Date: Mon, 11 Jan 2016 08:31:05 -0500 Subject: [PATCH] Add shortcut options to man page. --- src/cli/use.txt | 66 ++++++++++++++++++++++++------------------------- 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/src/cli/use.txt b/src/cli/use.txt index f9fd9fe..b8347d4 100644 --- a/src/cli/use.txt +++ b/src/cli/use.txt @@ -1,50 +1,50 @@ Usage: - hackmyresume [TO ] [] + hackmyresume [TO ] [] Available commands: - BUILD Build your resume to the destination format(s). - ANALYZE Analyze your resume for keywords, gaps, and metrics. - VALIDATE Validate your resume for errors and typos. - CONVERT Convert your resume between FRESH and JSON Resume. - NEW Create a new resume in FRESH or JSON Resume format. + BUILD Build your resume to the destination format(s). + ANALYZE Analyze your resume for keywords, gaps, and metrics. + VALIDATE Validate your resume for errors and typos. + CONVERT Convert your resume between FRESH and JSON Resume. + NEW Create a new resume in FRESH or JSON Resume format. Available options: - --theme Path to a FRESH or JSON Resume theme. - --pdf Specify the PDF engine to use (if any). - --opts Load options from an external JSON file. - --format The format (FRESH or JSON Resume) to use. - --debug Emit extended debugging info. - --assert Treat resume validation warnings as errors. - --no-colors Disable terminal colors. - --no-tips Disable theme messages and tips. - --help Display help documentation. - --version Display the current version. + --theme -t Path to a FRESH or JSON Resume theme. + --pdf -p Specify the PDF engine to use (if any). + --opts -o Load options from an external JSON file. + --format -f The format (FRESH or JSON Resume) to use. + --debug -d Emit extended debugging info. + --assert -a Treat resume validation warnings as errors. + --no-colors Disable terminal colors. + --no-tips Disable theme messages and tips. + --help -h Display help documentation. + --version -v Display the current version. Not all options are supported for all commands. For example, the --theme option is only supported for the BUILD command. Examples: - hackmyresume BUILD resume.json TO out/resume.all --theme modern - hackmyresume ANALYZE resume.json - hackmyresume NEW my-new-resume.json --format JRS - hackmyresume CONVERT resume-fresh.json TO resume-jrs.json - hackmyresume VALIDATE resume.json + hackmyresume BUILD resume.json TO out/resume.all --theme modern + hackmyresume ANALYZE resume.json + hackmyresume NEW my-new-resume.json --format JRS + hackmyresume CONVERT resume-fresh.json TO resume-jrs.json + hackmyresume VALIDATE resume.json Tips: - - You can specify multiple sources and/or targets for all commands. - - You can use any FRESH or JSON Resume theme with HackMyResume. - - Specify a file extension of .all to generate your resume to all - available formats supported by the theme. (BUILD command.) - - The --theme parameter can specify either the name of a preinstalled - theme, or the path to a local FRESH or JSON Resume theme. - - Visit https://www.npmjs.com/search?q=jsonresume-theme for a full - listing of all available JSON Resume themes. - - Visit https://github.com/fluentdesk/fresh-themes for a complete - listing of all available FRESH themes. - - Report bugs to https://githut.com/hacksalot/HackMyResume/issues - for a quick fix, often within 24 hours. + - You can specify multiple sources and/or targets for all commands. + - You can use any FRESH or JSON Resume theme with HackMyResume. + - Specify a file extension of .all to generate your resume to all + available formats supported by the theme. (BUILD command.) + - The --theme parameter can specify either the name of a preinstalled + theme, or the path to a local FRESH or JSON Resume theme. + - Visit https://www.npmjs.com/search?q=jsonresume-theme for a full + listing of all available JSON Resume themes. + - Visit https://github.com/fluentdesk/fresh-themes for a complete + listing of all available FRESH themes. + - Report bugs to https://githut.com/hacksalot/HackMyResume/issues + for a quick fix, often within 24 hours.