Updated supported format in docs

wummel · Feb 21, 2025 · 2ee92a1 · 2ee92a1
1 parent 594e731
commit 2ee92a1
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 38 deletions.
diff --git a/doc/changelog.txt b/doc/changelog.txt
@@ -1,6 +1,7 @@
-3.2.0 (released xx.xx.xxxx)
+4.0.0 (released xx.xx.xxxx)
   * Detect and use archive programs from Peazip installations.
     Closes: GH bug #51
+  * Require Python >= 3.11
 
 3.1.3 (released 15.02.2025)
   * Expand rar detection logic to all 7zip programs

diff --git a/doc/patool.1 b/doc/patool.1
@@ -37,7 +37,7 @@ ZOO (.zoo), ZPAQ (.zpaq) and ZSTANDARD (.zst) archive formats.
 It relies on helper applications to handle those archive formats
 (for example \fBxz\fP for XZ (.xz) archives).
 .PP
-The archive formats TAR, ZIP, BZIP2 and GZIP
+The archive formats BZIP2, GZIP, TAR, XZ and ZIP
 are supported natively and do not require helper applications to be
 installed.
 .SH EXAMPLES

diff --git a/doc/patool.txt b/doc/patool.txt
@@ -1,7 +1,7 @@
 PATOOL(1)               General Commands Manual              PATOOL(1)
 
 NAME
-       patool - portable archive file manager
+       patool - portable archive file manager for the command line
 
 SYNOPSIS
         patool         [global-options]        (list|test|extract|cre‐
@@ -29,8 +29,9 @@ DESCRIPTION
        It  relies  on helper applications to handle those archive for‐
        mats (for example xz for XZ (.xz) archives).
 
-       The archive formats TAR, ZIP, BZIP2 and GZIP are supported  na‐
-       tively and do not require helper applications to be installed.
+       The archive formats BZIP2, GZIP, TAR, XZ and ZIP are  supported
+       natively  and  do  not  require  helper  applications to be in‐
+       stalled.
 
 EXAMPLES
          patool extract archive.zip otherarchive.rar
@@ -43,23 +44,23 @@ EXAMPLES
 
 GLOBAL OPTIONS
        -v, --verbose
-              Display  more  info  about what patool does, and display
+              Display more info about what patool  does,  and  display
               the output of helper applications. Can be given multiple
               times to increase the output even more.
 
        -q, --quiet
-              Work  quietly,  exept  on  commands formats and version,
-              which still print their output.  Conflicts  with  --ver‐
-              bose.   If  given twice suppresses error output from ar‐
+              Work quietly, exept on  commands  formats  and  version,
+              which  still  print  their output. Conflicts with --ver‐
+              bose.  If given twice suppresses error output  from  ar‐
               chive commands.
 
        --non-interactive
-              Try to prevent any interactive user input (i.e.  prompt‐
-              ing  for  passwords or for overwriting duplicate files).
+              Try  to prevent any interactive user input (i.e. prompt‐
+              ing for passwords or for overwriting  duplicate  files).
               Use this option with care since overwriting files or ig‐
-              noring  password prompts could lead to unintended conse‐
+              noring password prompts could lead to unintended  conse‐
               quences.
-              This only works for programs that allow preventing  user
+              This  only works for programs that allow preventing user
               prompts. Currently those are arj, 7z and rar.
 
 COMMANDS
@@ -69,37 +70,37 @@ COMMANDS
 
        •   The original archive will never be removed.
 
-       •   Files  outside  the output directory will never be created.
+       •   Files outside the output directory will never  be  created.
            This relies on archive program options to prevent unpacking
-           of  files  with  an  absolute  path  name  (e.g. --no-abso‐
+           of files  with  an  absolute  path  name  (e.g.  --no-abso‐
            lute-filenames for cpio(1)).
 
        The following commands are available.
 
    extract
        patool extract [--outdir directory] <archive>...
 
-       Extract files from given archives. The original  archives  will
+       Extract  files  from given archives. The original archives will
        never be removed and are left as is.
 
        --outdir directory
               Extract to the given output directory. Default is to ex‐
               tract to the current working directory.
 
-       If the archive contains exactly one file or directory, the  ar‐
-       chive  contents are extracted directly to the output directory.
+       If  the archive contains exactly one file or directory, the ar‐
+       chive contents are extracted directly to the output  directory.
        Else the files are extracted in a newly created subdirectory of
-       the  output directory. The new directory is named after the ar‐
+       the output directory. The new directory is named after the  ar‐
        chive filename without the extension.
-       This prevents cluttering the output directory  with  a  lot  of
+       This  prevents  cluttering  the  output directory with a lot of
        files from the extracted archive.
 
-       All  extracted  files are ensured that they are readable by the
+       All extracted files are ensured that they are readable  by  the
        current user.
 
-       If extracting an archive has an error in the middle  of  opera‐
+       If  extracting  an archive has an error in the middle of opera‐
        tion, patool does not remove the temporary extraction directory
-       This directory whose name starts with "Unpack_" has  all  files
+       This  directory  whose name starts with "Unpack_" has all files
        that have been extracted before the error.
 
    list
@@ -110,16 +111,16 @@ COMMANDS
    create
        patool create <archive> <file-or-directory>...
 
-       Create  an  archive from given files. All of the given files to
-       add to the archive must be readable by the current  user.   The
-       format  of  the  archive to create is determined by the archive
-       file extension. If the archive program has options to  maximize
+       Create an archive from given files. All of the given  files  to
+       add  to  the archive must be readable by the current user.  The
+       format of the archive to create is determined  by  the  archive
+       file  extension. If the archive program has options to maximize
        file compression, patool uses those options.
 
    test
        patool test <archive>...
 
-       Test  the  given  archives.  If the helper application does not
+       Test the given archives. If the  helper  application  does  not
        support testing, the archive contents are listed instead.
 
    diff
@@ -132,21 +133,21 @@ COMMANDS
        patool search <pattern> <archive>
 
        Unpack the given archive in a temporary directory and search in
-       archive contents for given pattern using the  grep(1)  program.
-       The  grep  options  used are -r; additional options can be sup‐
+       archive  contents  for given pattern using the grep(1) program.
+       The grep options used are -r; additional options  can  be  sup‐
        plied with the GREP_OPTIONS environment variable.
 
    repack
        patool repack <archive> <archive_new>
 
-       Extract and re-compress archive to  a  different  format.   The
-       target  archive  format  is determined by the file extension of
+       Extract  and  re-compress  archive  to a different format.  The
+       target archive format is determined by the  file  extension  of
        archive_new.
 
    formats
        patool formats
 
-       Show all supported archive formats (i.e. which helper  applica‐
+       Show  all supported archive formats (i.e. which helper applica‐
        tions are available).
 
    version
@@ -155,14 +156,14 @@ COMMANDS
        Print version information.
 
 HELP OPTION
-       Specifying  the help option displays help for patool itself, or
+       Specifying the help option displays help for patool itself,  or
        a command.
        For example:
          patool --help - display help for patool
          patool extract --help - display help for the extract command
 
 SHELL ALIASES
-       When running under a Unix shell the following  aliases  can  be
+       When  running  under  a Unix shell the following aliases can be
        defined to save some typing:
          alias pl='patool list'
          alias px='patool extract'

diff --git a/doc/web/source/index.md b/doc/web/source/index.md
@@ -33,9 +33,9 @@ ZIP (.zip, .jar, .cbz), ZOO (.zoo) and ZSTANDARD (.zst) archive formats.
 It relies on helper applications to handle those archive formats
 (for example `xz` for XZ (.xz) archives).
 
-The  archive  formats  TAR, ZIP, BZIP2 and
-GZIP are supported natively and  do  not  require  helper
-applications to be installed.
+The archive formats BZIP2, GZIP, TAR, XZ and ZIP are  supported
+natively  and  do  not  require  helper  applications to be
+installed.
 
 Installation
 -------------