From 7c817e620be9013466d4dd008a2f1dbffcf7517e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Wirtel?= Date: Wed, 10 Oct 2018 08:28:26 +0200 Subject: bpo-34913: Document gzip command line interface (GH-9782) --- Doc/library/gzip.rst | 35 ++++++++++++++++++++++ .../2018-10-10-00-34-08.bpo-34913.kVd1Fv.rst | 1 + 2 files changed, 36 insertions(+) create mode 100644 Misc/NEWS.d/next/Documentation/2018-10-10-00-34-08.bpo-34913.kVd1Fv.rst diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst index 9c6b722..b52dd1a 100644 --- a/Doc/library/gzip.rst +++ b/Doc/library/gzip.rst @@ -211,3 +211,38 @@ Example of how to GZIP compress a binary string:: The basic data compression module needed to support the :program:`gzip` file format. +Command Line Interface +---------------------- + +The :mod:`gzip` module provides a simple command line interface to compress or +decompress files. + +Once executed the :mod:`gzip` module keeps the input file(s). + +.. versionchanged:: 3.8 + + Add a new command line interface with a usage. + +Command line options +^^^^^^^^^^^^^^^^^^^^ + +.. cmdoption:: file + + .. code-block:: shell-session + + $ python -m gzip file + + If *file* is not specified, read from :attr:`sys.stdin`. + +.. cmdoption:: -d, --decompress + + Decompress the given file + + .. code-block:: shell-session + + $ python -m gzip -d file.gz + +.. cmdoption:: -h, --help + + Show the help message. + diff --git a/Misc/NEWS.d/next/Documentation/2018-10-10-00-34-08.bpo-34913.kVd1Fv.rst b/Misc/NEWS.d/next/Documentation/2018-10-10-00-34-08.bpo-34913.kVd1Fv.rst new file mode 100644 index 0000000..e8a1176 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2018-10-10-00-34-08.bpo-34913.kVd1Fv.rst @@ -0,0 +1 @@ +Add documentation about the new command line interface of the gzip module. -- cgit v0.12