Docs: Better documentation for rm.py -f

[ppu.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index f339591f6e46d3a9e2a1bb3a91e405dfc93de6ed..975d62e3c17efc92cc62a7716fe853f05284a429 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,13 +1,10 @@
-.. remove-old-files documentation master file, created by
+.. ppu documentation master file, created by
    sphinx-quickstart on Sat Apr 15 20:37:34 2017.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to remove-old-files's documentation!
-============================================
-
-Remove old files. It's a portable replacement for
-`find start_dir -type f -mtime +31 -delete`.
+Portable Python Utilities
+=========================
 
 .. toctree::
    :maxdepth: 2
@@ -21,12 +18,32 @@ Remove old files. It's a portable replacement for
 Command line
 ------------
 
+cmp.py
+~~~~~~
+
+Compare two files.
+
+Usage::
+
+    cmp.py [-i] [-s --silent --quiet] file1 file2
+
+Options::
+
+    -i, --inhibit-progress-bar
+                                 inhibit progress bar
+    -s, --silent, --quiet
+                                 be silent (implied -i)
+
+
 remove-old-files.py
 ~~~~~~~~~~~~~~~~~~~
 
+Remove old files. It's a portable replacement for
+`find start_dir -type f -mtime +31 -delete`.
+
 Usage::
 
-    remove-old-files.py -o days start_dir
+    remove-old-files.py [-e] -o days start_dir
 
 Options::
 
@@ -36,6 +53,34 @@ Options::
                            remove files older than this number of days;
                            this is a required option
 
+rm.py
+~~~~~
+
+Remove files or directories. Ask interactively to remove read-only files or
+directories.
+
+Usage::
+
+    rm.py [-r] [-f] name1 [name2...]
+
+Options::
+
+    -r, --recursive
+                        recursively remove directories
+    -f', --force
+                        force (ignore non-existing files and errors,
+                        remote read-only files and non-empty directories)
+
+
+which.py
+~~~~~~~~
+
+Find a program in PATH and print full path to it.
+
+Usage::
+
+    which.py program
+
 Indices and tables
 ==================