Browse Source

bpo-34913: Document gzip command line interface (GH-9782)

pull/9337/merge
Stéphane Wirtel 7 years ago
committed by Julien Palard
parent
commit
7c817e620b
  1. 35
      Doc/library/gzip.rst
  2. 1
      Misc/NEWS.d/next/Documentation/2018-10-10-00-34-08.bpo-34913.kVd1Fv.rst

35
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.

1
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.
Loading…
Cancel
Save