Update documentation
This commit is contained in:
parent
3202c820d3
commit
53961f956e
21
README.md
21
README.md
|
@ -18,12 +18,23 @@ By default, dfmt reads its input from ```stdin``` and writes to ```stdout```.
|
||||||
If a file name is specified on the command line, input will be read from the
|
If a file name is specified on the command line, input will be read from the
|
||||||
file instead, and output will be written to ```stdout```.
|
file instead, and output will be written to ```stdout```.
|
||||||
### Options
|
### Options
|
||||||
|
* ```--help```:
|
||||||
* ```--inplace```: a file name is required and the file will be edited in-place.
|
* ```--inplace```: a file name is required and the file will be edited in-place.
|
||||||
* ```--braces=otbs```: Use ["The One True Brace Style"](https://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS), placing open braces on
|
* ```--align_switch_statements```: See ```dfmt_align_switch_statements``` below
|
||||||
the same line as the previous token.
|
* ```--brace_style```: See ``brace_style``` below
|
||||||
* ```--braces=allman```: Use ["Allman Style"](https://en.wikipedia.org/wiki/Indent_style#Allman_style),
|
* ```--end_of_line```: See ```end_of_line``` below
|
||||||
placing opening braces on their own line. This is the default.
|
* ```--indent_size```: See ```indent_size``` below
|
||||||
* ```--tabs```: Use tabs for indentation instead of spaces.
|
* ```--indent_style```: See ```indent_style``` below
|
||||||
|
* ```--max_line_length```: See ```max_line_length``` below
|
||||||
|
* ```--soft_max_line_length```: See ```dfmt_soft_max_line_length``` below
|
||||||
|
* ```--outdent_attributes```: See ```dfmt_outdent_attributes``` below
|
||||||
|
* ```--outdent_labels```: See ```dfmt_outdent_labels``` below
|
||||||
|
* ```--space_after_cast```: See ```dfmt_space_after_cast``` below
|
||||||
|
* ```--split_operator_at_line_end```: See ```dfmt_split_operator_at_line_end``` below
|
||||||
|
* ```--tab_width```: See ```tab_width``` below
|
||||||
|
|
||||||
|
### Example
|
||||||
|
```dfmt --inplace --space_after_cast=false --max_line_length=80 --soft_max_line_length=70 file.d```
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
**dfmt** uses [EditorConfig](http://editorconfig.org/) configuration files.
|
**dfmt** uses [EditorConfig](http://editorconfig.org/) configuration files.
|
||||||
|
|
Loading…
Reference in New Issue