X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=docs%2Findex.rst;h=014ff629f9241aa62379539fd3b10ee646ffce4e;hb=b6804601cdf52546c13a0c0dde0f6c22f9c7d82a;hp=17c64cbbfd55ca245d93273d1e36b3a014be2805;hpb=5ff3d7feb2e7405d407fde480a6573d0c5c2b9db;p=ppu.git diff --git a/docs/index.rst b/docs/index.rst index 17c64cb..014ff62 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,16 +1,76 @@ -.. 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! -============================================ +Portable Python Utilities +========================= .. toctree:: :maxdepth: 2 :caption: Contents: + install + news +.. highlight:: none + +Command line +------------ + +cmp.py +~~~~~~ + +Compare two files. + +Usage:: + + cmp.py file1 file2 + +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 [-e] -o days start_dir + +Options:: + + -e, --empty-dirs + remove empty directories + -o days, --older days + 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] name1 [name2...] + +Options:: + + -r, --recursive + recursively remove directories + -f', --force + force (ignore non-existing files and errors) + + +which.py +~~~~~~~~ + +Find a program in PATH and print full path to it. + +Usage:: + + which.py program Indices and tables ==================