docs/index.rst

   1 .. remove-old-files 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 Welcome to remove-old-files's documentation!
   7 ============================================
   8
   9 Remove old files. It's a portable replacement for
  10 `find start_dir -type f -mtime +31 -delete`.
  11
  12 .. toctree::
  13    :maxdepth: 2
  14    :caption: Contents:
  15
  16    install
  17    news
  18
  19 .. highlight:: none
  20
  21 Command line
  22 ------------
  23
  24 remove-old-files.py
  25 ~~~~~~~~~~~~~~~~~~~
  26
  27 Usage::
  28
  29     remove-old-files.py -o days start_dir
  30
  31 Options::
  32
  33     -e, --empty-dirs
  34                            remove empty directories
  35     -o days, --older days
  36                            remove files older than this number of days;
  37                            this is a required option
  38
  39 Indices and tables
  40 ==================
  41
  42 * :ref:`genindex`
  43 * :ref:`modindex`
  44 * :ref:`search`