book/text/ref_commands.glyph in glyph-0.5.1 vs book/text/ref_commands.glyph in glyph-0.5.2

- old
+ new

@@ -13,26 +13,26 @@ @title[code[-d], code[--debug]] @id[debug_switch] p[If specified, the command is executed in debug mode and additional diagnostic information is printed on the screen.] ] section[ - @title[code[-v], code[--version]] - @id[version_switch] - p[Prints the current version of Glyph, ignoring any other command or switches.] + @title[code[-h], code[--help]] + @id[help_switch] + p[Displays help on the program.] ] ] section[ - @title[add] + @title[code[add]] @id[c_add] p[Creates a new text file in the code[text/] folder.] example[glyph add introduction.textile] parameters[ -p[em[file_name]|The name (or relative path) of the new file to be created.] ] ] section[ - @title[compile] + @title[code[compile]] @id[c_compile] p[Compiles a Glyph document into an output file. If no options are specified, the code[document.glyph] file is used as source to produce a standalone HTML file.] example[glyph compile -f pdf] parameters[ -p[em[source]|The source glyph file to compile em[(Optional)].] @@ -52,16 +52,18 @@ If specified, enable =>[#auto_regeneration|auto regeneration] (requires the =>[http://rubygems.org/gems/directory_watcher|directory_watcher] gem to be installed). ] ] ] section[ - @title[config] + @title[code[config]] @id[c_config] Gets or sets a configuration setting in the project or global configuration file (\/fmi[configuration files|#cfg]). - examples[ -glyph config document.filename -glyph config -g document.author "Fabio Cevasco" + §[ + @title[Examples] + @notoc[true] + p[code[glyph config document.filename]] + p[code[glyph config -g document.author "Fabio Cevasco"]] ] options[ -o[global| If specified, the global configuration file is processed instead of the project file. default[false] @@ -71,29 +73,31 @@ -p[em[setting]|The name of a valid =>[#cfg_ref|configuration setting].] -p[em[value]|The new value of the configuration setting.] ] ] section[ - @title[help] + @title[code[help]] @id[c_help] Prints information about all Glyph commands or about one specific command. - examples[ -glyph help -glyph help compile + §[ + @title[Examples] + @notoc[true] + p[code[glyph help]] + p[code[glyph help compile]] ] parameters[ -p[em[command]|A valid Glyph command.] ] ] section[ - @title[init] + @title[code[init]] @id[c_init] Creates a new Glyph project in the current directory (if empty). example[glyph init] ] section[ - @title[outline] + @title[code[outline]] @id[c_outline] Display an outline of the current document. options[ -o[limit| Only display headers until the specified level. @@ -106,25 +110,29 @@ ] -o[titles| Display section titles. ] ] - examples[ -glyph outline -it -l 1 -glyph outline -l 2 -glyph outline -f + §[ + @title[Examples] + @notoc[true] + p[code[glyph outline -it -l 1]] + p[code[glyph outline -l 2]] + p[code[glyph outline -f]] ] ] section[ - @title[stats] + @title[code[stats]] @id[c_stats] def:[stats_option|-o[{{0}}|If specified, general statistics about {{0}} are displayed (see =>[#stats_{{0}}]).]] def:[stats_long_option|long_option[{{0}}|Display detailed statistics about the specified {{0}}.]] p[Displays project statistics (\/fmi[this command|#stats]).] - examples[ -glyph stats -m -glyph stats --link=h3rald.com + §[ + @title[Examples] + @notoc[true] + p[code[glyph stats -m]] + p[code[glyph stats --link=h3rald.com]] ] options[ stats_option[bookmarks] stats_long_option[bookmark] -o[files|If specified, general statistics about project files are displayed.] @@ -135,10 +143,10 @@ stats_option[snippets] stats_long_option[snippet] ] ] section[ - @title[todo] + @title[code[todo]] @id[c_todo] Prints all the todo items saved using the %>[todo]. example[glyph todo] ]