Initial docs

[ppu.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 17c64cbbfd55ca245d93273d1e36b3a014be2805..1fa41621e8280de94716b9a1d9a53fa169e2248d 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -6,11 +6,32 @@
 Welcome to remove-old-files's documentation!
 ============================================
 
+Remove old files. It's a portable replacement for
+`find start_dir -type f -mtime +31 -delete`.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   news
+
+.. highlight:: none
+
+Command line
+------------
+
+remove-old-files.py
+~~~~~~~~~~~~~~~~~~~
+
+Usage::
+
+    remove-old-files.py -o days start_dir
+
+Options::
 
+    -o days, --older days
+                           remove files older than this number of days;
+                           this is a required option
 
 Indices and tables
 ==================