X-Git-Url: http://nitlanguage.org diff --git a/share/man/nitpretty.md b/share/man/nitpretty.md index 0864629..629fe96 100644 --- a/share/man/nitpretty.md +++ b/share/man/nitpretty.md @@ -1,5 +1,3 @@ -% NITPRETTY(1) - # NAME nitpretty - pretty print Nit code from Nit source files. @@ -10,20 +8,42 @@ nitpretty [*options*]... FILE # OPTIONS -`--dir` -: Working directory (default is '.nitpretty') +### `--dir` +Working directory (default is '.nitpretty'). + +### `-o`, `--output` +Output name (default is pretty.nit). + +### `--diff` +Show diff between source and output. + +### `--meld` +Show diff between source and output using meld. + +### `--check` +Check format of Nit source files. + +This option creates a temporary pretty printed file then checks if the output +of the diff command on the source file and the pretty printed one is empty. + +### `--break-strings` +Break too long string literals. + +### `--inline-do` +Force do keyword on the same line as the method signature. -`-o`, `--output` -: Output name (default is pretty.nit) +### `--skip-empty` +Force formatting of empty lines. -`--diff` -: Show diff between source and output +By default empty lines are kept as they were typed in the file. +When enabling this option, `nitpretty` will decide where to break lines and +will put empty lines to separate properties and code blocks. -`--meld` -: Show diff between source and output using meld +### `--line-width` +Maximum length of lines (use 0 to disable automatic line breaks). -`--check` -: Check format of Nit source files +### `--no-inline` +Disable automatic one-liners. # SPECIFICATION