From: Stéphane Wirtel <stephane@wirtel.be>
Date: Wed, 10 Oct 2018 06:28:26 +0000 (+0200)
Subject: bpo-34913: Document gzip command line interface (GH-9782)
X-Git-Tag: v3.8.0a1~802
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7c817e620be9013466d4dd008a2f1dbffcf7517e;p=thirdparty%2FPython%2Fcpython.git

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

diff --git a/Doc/library/gzip.rst b/Doc/library/gzip.rst
index 9c6b72237177..b52dd1a11aa9 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 000000000000..e8a11761477c
--- /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.