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 file1 file2
  29
  30 remove-old-files.py
  31 ~~~~~~~~~~~~~~~~~~~
  32
  33 Remove old files. It's a portable replacement for
  34 `find start_dir -type f -mtime +31 -delete`.
  35
  36 Usage::
  37
  38     remove-old-files.py [-e] -o days start_dir
  39
  40 Options::
  41
  42     -e, --empty-dirs
  43                            remove empty directories
  44     -o days, --older days
  45                            remove files older than this number of days;
  46                            this is a required option
  47
  48 rm.py
  49 ~~~~~
  50
  51 Remove files or directories. Ask interactively to remove read-only files or
  52 directories.
  53
  54 Usage::
  55
  56     rm.py [-r] name1 [name2...]
  57
  58 Options::
  59
  60     -r, --recursive
  61                         recursively remove directories
  62     -f', --force
  63                         force (ignore non-existing files and errors)
  64
  65
  66 which.py
  67 ~~~~~~~~
  68
  69 Find a program in PATH and print full path to it.
  70
  71 Usage::
  72
  73     which.py program
  74
  75 Indices and tables
  76 ==================
  77
  78 * :ref:`genindex`
  79 * :ref:`modindex`
  80 * :ref:`search`