docs/index.rst

   1 .. ppu documentation master file, created by
   2    sphinx-quickstart on Sat Apr 15 20:37:34 2017.
   3    You can adapt this file completely to your liking, but it should at least
   4    contain the root `toctree` directive.
   5
   6 Portable Python Utilities
   7 =========================
   8
   9 .. toctree::
  10    :maxdepth: 2
  11    :caption: Contents:
  12
  13    install
  14    news
  15
  16 .. highlight:: none
  17
  18 Command line
  19 ------------
  20
  21 cmp.py
  22 ~~~~~~
  23
  24 Compare two files.
  25
  26 Usage::
  27
  28     cmp.py [-i] [-s --silent --quiet] file1 file2
  29
  30 Options::
  31
  32     -i, --inhibit-progress-bar
  33                                  inhibit progress bar
  34     -s, --silent, --quiet
  35                                  be silent (implied -i)
  36
  37
  38 remove-old-files.py
  39 ~~~~~~~~~~~~~~~~~~~
  40
  41 Remove old files. It's a portable replacement for
  42 `find start_dir -type f -mtime +31 -delete`.
  43
  44 Usage::
  45
  46     remove-old-files.py [-e] -o days start_dir
  47
  48 Options::
  49
  50     -e, --empty-dirs
  51                            remove empty directories
  52     -o days, --older days
  53                            remove files older than this number of days;
  54                            this is a required option
  55
  56 rm.py
  57 ~~~~~
  58
  59 Remove files or directories. Ask interactively to remove read-only files or
  60 directories.
  61
  62 Usage::
  63
  64     rm.py [-r] name1 [name2...]
  65
  66 Options::
  67
  68     -r, --recursive
  69                         recursively remove directories
  70     -f', --force
  71                         force (ignore non-existing files and errors)
  72
  73
  74 which.py
  75 ~~~~~~~~
  76
  77 Find a program in PATH and print full path to it.
  78
  79 Usage::
  80
  81     which.py program
  82
  83 Indices and tables
  84 ==================
  85
  86 * :ref:`genindex`
  87 * :ref:`modindex`
  88 * :ref:`search`