astyle.1 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. .TH ASTYLE 1 @DATE@ @VERSION@ "SlackBuilds.org"
  2. .SH NAME
  3. astyle \- multi-language indentation and reformatting filters
  4. .SH SYNOPSIS
  5. .B astyle
  6. \fBastyle\fR [\fIoptions\fR] \fIFile1\fR [\fIFile2\fR] [\fI...\fR]
  7. .SH DESCRIPTION
  8. \fBArtistic Style\fR (or \fBastyle\fR) is a source code indenter, formatter
  9. and beautifier, written in C++. It handles the following programming languages:
  10. .RS
  11. .IP \(bu 3
  12. C
  13. .IP \(bu 3
  14. C++
  15. .IP \(bu 3
  16. C++/CLI
  17. .IP \(bu 3
  18. Objective-C
  19. .IP \(bu 3
  20. C#
  21. .IP \(bu 3
  22. Java
  23. .RE
  24. .SH USAGE
  25. For the full usage, please refer to the HTML documentation provided with this
  26. distribution in \fI/usr/doc/astyle\-@VERSION@/html/astyle.html\fR.
  27. .P
  28. .B astyle
  29. has \fImany\fR command\-line options.
  30. For a summary, run "\fBastyle \-\-help | less\fR".
  31. .P
  32. Please note that when indenting a specific file the newly indented file retains
  33. the original filename, while a copy of the original file is created, with a
  34. suffix of ".orig" added to the original filename.
  35. .SH OPTIONS
  36. Here is a brief list of options, copied from the HTML documentation. Most
  37. of these can appear either as command line options (with \-\- prefixed)
  38. or option file directives.
  39. .nf
  40. .eo
  41. Brace Style Options
  42. default brace style style=allman style=java style=kr
  43. style=stroustrup style=whitesmith style=vtk style=ratliff style=gnu
  44. style=linux style=horstmann style=1tbs style=google style=mozilla
  45. style=pico style=lisp
  46. Tab Options
  47. default indent indent=spaces indent=tab indent=force-tab
  48. --indent=force-tab-x
  49. Brace Modify Options
  50. attach-namespaces attach-classes attach-inlines attach-extern-c
  51. attach-closing-while
  52. Indentation Options
  53. indent-classes indent-modifiers indent-switches indent-cases
  54. indent-namespaces indent-after-parens indent-continuation
  55. indent-labels indent-preproc-block indent-preproc-define
  56. indent-preproc-cond indent-col1-comments min-conditional-indent
  57. max-continuation-indent
  58. Padding Options
  59. break-blocks break-blocks=all pad-oper pad-comma pad-paren
  60. pad-paren-out pad-first-paren-out pad-paren-in pad-header
  61. unpad-paren delete-empty-lines fill-empty-lines align-pointer
  62. align-reference
  63. Formatting Options
  64. break-closing-braces break-elseifs break-one-line-headers add-braces
  65. add-one-line-braces remove-braces break-return-type attach-return-type
  66. keep-one-line-blocks keep-one-line-statements convert-tabs
  67. close-templates remove-comment-prefix max-code-length
  68. break-after-logical mode
  69. Objective-C Options
  70. pad-method-prefix unpad-method-prefix pad-return-type
  71. unpad-return-type pad-param-type unpad-param-type align-method-colon
  72. pad-method-colon
  73. Other Options
  74. suffix suffix=none recursive dry-run exclude
  75. ignore-exclude-errors ignore-exclude-errors-x errors-to-stdout
  76. preserve-date verbose formatted quiet lineend
  77. Command Line Only
  78. options project ascii version help html html= stdin=
  79. stdout=
  80. .ec
  81. .fi
  82. .SH "SEE ALSO"
  83. .BR indent(1)
  84. .I http://astyle.sourceforge.net/
  85. .br
  86. .I http://www.sourceforge.net/projects/astyle/
  87. .br
  88. .I /usr/doc/astyle\-3.1/html/astyle.html
  89. .SH AUTHOR
  90. Artistic Style was originally written by Tal Davidson <davidsont@bigfoot.com>
  91. and is currently maintained by Jim Pattee <jimp03@email.com>.
  92. This stub manual page was written by Matteo Cypriani <mcy@lm7.fr>
  93. for the Debian project, and modified by B. Watson <urchlay@slackware.uk>
  94. for the SlackBuilds.org project.