Next: , Previous: Informational commands, Up: Top   [Contents][Index]


8 Common command-line options for commenting-style detection

These options appear in the boilerplate, cbb, comment, uncomment, and apply commands.

--c-style

For boilerplate and cbb, this option detects comments at the start of the file in blocks like: ‘/* this */’, or whole-line comments like ‘// this’.

--c++-style

Same as ‘--c-style’.

--shell-style

For boilerplate, uncomment, and cbb, this option detects comments at the start of the file in whole-line comments that look like ‘# this’.

--scheme-style

For boilerplate, uncomment, and cbb, this option detects comments at the start of the file in whole-line comments that look like ‘; this’.

--texinfo-style

For boilerplate, uncomment, and cbb, this option detects comments at the start of the file in whole-line comments that look like ‘@c this’ or ‘@comment this’.

--m4-style

For boilerplate, uncomment, and cbb, this option detects comments at the start of the file in whole-line comments that look like ‘# this’, or ‘dnl this’.

--haskell-style

For boilerplate, uncomment, and cbb, this option detects comments at the start of the file in blocks like ‘{- this - }’, or whole-line comments like ‘-- this’.

--groff-style

Groff is the GNU program for making man pages. It is also called troff. For boilerplate, uncomment, and cbb, this option detects comments at the start of the file in whole-line comments that look like: ‘\" this’, ‘.\" this’, ‘\" this’, or ‘.\" this’.

--gettext-style

For boilerplate, uncomment, and cbb, this option detects comments at the start of the file in whole-line comments that look like ‘# this’. The space after ‘#’ is required, as ‘#,’ and ‘#:’ are valid gettext symbols and not comments.

--fortran-style

For boilerplate, uncomment, and cbb, this option detects comments at the start of the file in whole-line comments that look like ‘C this’, or ‘! this’.

--pascal-style

For boilerplate, uncomment, and cbb, this option detects comments at the start of the file in blocks like ‘(* this *)’, or ‘{* this *}’, or whole-line comments like ‘// this’.

For the apply command, these options put the current working boilerplate after the existing boilerplate in the given style.

For the comment command, this option creates a comment in the given style.

There is a --style option that requires the name of a commenting style as an argument. This option does not appear in the --help of commands, but it still works.

For the sake of brevity, only a subset of the commenting styles are shown in the --help of commands. The --help-all-styles option will display all of the supported commenting style options.


Next: , Previous: Informational commands, Up: Top   [Contents][Index]