Skip to content

Commit

Permalink
Add a section about 'Option: output-file'
Browse files Browse the repository at this point in the history
  • Loading branch information
raimon49 committed Dec 14, 2019
1 parent 2705b63 commit 2e62bda
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ Dump the software license list of Python packages installed with pip.
* [CSV](#csv)
* [Deprecated options](#deprecated-options)
* [Option: summary](#option-summary)
* [Option: output\-file](#option-output-file)
* [More Information](#more-information)
* [Dockerfile](#dockerfile)
* [License](#license)
Expand Down Expand Up @@ -348,6 +349,15 @@ When executed with the `--summary` option, you can output a summary of each lice

**Note:** When using this option, only `--order=count` or `--order=license` has an effect for the `--order` option. And using `--with-authors` and `--with-urls` will be ignored.

### Option: output\-file

When executed with the `--output-file` option, write the result to the path specified by the argument.

```
(venv) $ pip-licenses --format=rst --output-file=/tmp/output.rst
created path: /tmp/output.rst
```

### More Information

Other, please make sure to execute the `--help` option.
Expand Down

0 comments on commit 2e62bda

Please sign in to comment.