From 2e62bda4c66daf51e25f8a4bf1bda2dd09bf92b5 Mon Sep 17 00:00:00 2001 From: raimon Date: Sat, 14 Dec 2019 16:44:23 +0900 Subject: [PATCH] Add a section about 'Option: output-file' --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 2c3a822..15f723c 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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.