https://hg.python.org/cpython/rev/feb6e8678512 changeset: 104871:feb6e8678512 branch: 2.7 parent: 104866:8f9c54a75c3d user: Serhiy Storchaka <storchaka@gmail.com> date: Wed Nov 02 12:05:54 2016 +0200 summary: Issue #28513: Documented command-line interface of zipfile. files: Doc/library/zipfile.rst | 57 +++++++++++++++++++++++++++++ Misc/NEWS | 2 + 2 files changed, 59 insertions(+), 0 deletions(-) diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -497,4 +497,61 @@ Size of the uncompressed file. + +.. _zipfile-commandline: +.. program:: zipfile + +Command-Line Interface +---------------------- + +The :mod:`zipfile` module provides a simple command-line interface to interact +with ZIP archives. + +If you want to create a new ZIP archive, specify its name after the :option:`-c` +option and then list the filename(s) that should be included: + +.. code-block:: shell-session + + $ python -m zipfile -c monty.zip spam.txt eggs.txt + +Passing a directory is also acceptable: + +.. code-block:: shell-session + + $ python -m zipfile -c monty.zip life-of-brian_1979/ + +If you want to extract a ZIP archive into the specified directory, use +the :option:`-e` option: + +.. code-block:: shell-session + + $ python -m zipfile -e monty.zip target-dir/ + +For a list of the files in a ZIP archive, use the :option:`-l` option: + +.. code-block:: shell-session + + $ python -m zipfile -l monty.zip + + +Command-line options +~~~~~~~~~~~~~~~~~~~~ + +.. cmdoption:: -l <zipfile> + + List files in a zipfile. + +.. cmdoption:: -c <zipfile> <source1> ... <sourceN> + + Create zipfile from source files. + +.. cmdoption:: -e <zipfile> <output_dir> + + Extract zipfile into target directory. + +.. cmdoption:: -t <zipfile> + + Test whether the zipfile is valid or not. + + .. _PKZIP Application Note: https://pkware.cachefly.net/webdocs/casestudies/APPNOTE.TXT diff --git a/Misc/NEWS b/Misc/NEWS --- a/Misc/NEWS +++ b/Misc/NEWS @@ -236,6 +236,8 @@ Documentation ------------- +- Issue #28513: Documented command-line interface of zipfile. + - Issue #16484: Change the default PYTHONDOCS URL to "https:", and fix the resulting links to use lowercase. Patch by Sean Rodman, test by Kaushik Nadikuditi. -- Repository URL: https://hg.python.org/cpython