Commits

Anonymous committed 3d1f817

updated docs

  • Participants
  • Parent commits b4f997a

Comments (0)

Files changed (2)

management/commands/filewatch.py

 # -*- coding: utf-8 -*-
 """
-execution de la surveillance
-parcours de la liste des fichiers ŕ surveiller
-generation / envoi de report si modifs
+Filewatch command
 
 manage.py filewatch
 
     prints report to console (standard output)
 
 --email
-    sends report by email email to settings.ADMINS
+    sends report by email to settings.ADMINS
 
 --add path
     add a path to watch list, either single file
 Typical usage
 =============
 
-1. Execute manage.py filewatch --add path to add files in path to watchlist
+1. Execute "manage.py filewatch --add path" to add files in path to watchlist
     May be a single file. If path is a directory, it will add files in path
     in watchlist if they have a .py, .php, .php4, .php5, .html or .js extension.
-2. Add manage.py filewatch --email as a cronjob. If one or more file has been modifed,
+2. Add "manage.py filewatch --email" as a cronjob. If one or more file has been modifed,
     it will sends a report by email to settings.ADMINS
     
+If you update files intentionnaly, you will have to execute
+"manage.py filewatch --update path" to update file signatures.
+Elsewhere, you may keep receiving alert reports.
+    
 Reports are saved in database too. See management/commands/filewatch.py
 docstring for more options (update, list, remove, clear etc)