Tiny introduction/help

git-svn-id: svn+ssh://asteria.noreply.org/svn/weaselutils/trunk@430 bc3d92e2-beff-0310-a7cd-cc87d7ac0ede

1 files changed, 17 insertions, 0 deletions

diff --git a/publish b/publish
index 7a7d68b..964d40b 100755
--- a/publish
+++ b/publish
@@ -27,6 +27,23 @@
 # Author: Florian Reitmeir
 # E-mail: florian@reitmeir.org
 
+# Publishes files on a webserver.
+#
+# This script copies files or directories as given on the command line,
+# or stdin or the xclipboard, to a remote location using rsync.  That
+# remote directory should be exposed online and ideally be o-r or have
+# indexing disabled.
+#
+# The directory names chosen by this script are random(ish) but still
+# contain a date string so one know how old things are when looking at them
+# (Or one can just have cron clean out stuff older than a week or a month
+# automagically).
+#
+# The random location chosen is printed to stdout when the script finishes,
+# and is copied to the xclipboard if the xclip(1) utility is installed·
+#
+# base_http and base_rsync can be overriden in a ~/.publish.cfg shell snippet.
+
 base_http=http://www.example.com/pub
 base_rsync=marvin.example.com:/var/www/www.example.com/htdocs/pub