Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

added usage summary to README

  • Loading branch information...
commit e3ca5981252828bf991cf97d6243613e7a106a02 1 parent a6abced
@estrabd authored
Showing with 41 additions and 7 deletions.
  1. +34 −0 README
  2. +7 −7 bin/vee
View
34 README
@@ -19,3 +19,37 @@ estrabd at gmail dot commie
It's also on Freshmeat:
http://freshmeat.net/projects/vee-the-blog-tool
+
+Version: 0.9.9-zeta
+
+Usage:
+ See below.
+
+Options:
+ -b batch mode; used when piping in msg via stdin
+ -B file define bottom template; default is ./vee-bottom.tpl
+ -c [1-9\d*] specify the number of characters 'fold' allows per line
+ this only applies when 'fold' (-f) is used
+ -d 'publis_dir' specify the directory .vee is in - defaults to PWD
+ -f 'format' use defined format instead of the default, groff;
+ 'groff', 'fold', and 'none' are supported out of the box
+ -h prints this blurb
+ -i 'custom.html' specify a custom index file over the default
+ -I force index file to be "index.html"
+ -l edit latest post's *.raw; used with '-r' publishes changes;
+ calls reformat automatically;
+ -L [1-9\d*] edit the Nth latest, relative to last post; lp starts at 1
+ -m 'message ...' specify entry message at commandline and avoid vi
+ -n lists all entries, newest first, then quits
+ -o lists all entries, oldest first, then quits
+ -p see what *raw files don't have an entry in the INDEX
+ -P forever deletes all *raw and formatted files associated with
+ posts that are listed with -p;
+ -r [1-9\d*] reformats the Nth latest post
+ -R reformats _all_ .vee/*.raw files; -c applies as well
+ -s summary placed below title in INDEX
+ -t 'title' specify title at commandline and avoid annoying default prompt
+ -T file define top template; default is ./vee-top.tpl
+ -v version and exit
+ -x filter defines filter if not using default ./vee-pre; filter
+ must be executable, i.e., chmod 755 vee-pre
View
14 bin/vee
@@ -140,10 +140,10 @@ CUSTOM_SETUP=default_setup
echo " -b batch mode; used when piping in msg via stdin "
echo " -B file define bottom template; default is ./vee-bottom.tpl "
echo " -c [1-9\d*] specify the number of characters 'fold' allows per line "
- echo " this only applies when 'fold' (-f) is used "
+ echo " this only applies when 'fold' (-f) is used "
echo " -d 'publis_dir' specify the directory .vee is in - defaults to PWD "
- echo " -f 'format' use defined format instead of the default, groff;"
- echo " 'groff', 'fold', and 'none' are supported out of the box"
+ echo " -f 'format' use defined format instead of the default, groff; "
+ echo " 'groff', 'fold', and 'none' are supported out of the box "
echo " -h prints this blurb "
echo " -i 'custom.html' specify a custom index file over the default "
echo " -I force index file to be \"index.html\" "
@@ -162,7 +162,7 @@ CUSTOM_SETUP=default_setup
echo " -t 'title' specify title at commandline and avoid annoying default prompt"
echo " -T file define top template; default is ./vee-top.tpl "
echo " -v version and exit "
- echo " -x filter defines filter if not using default "./vee-pre"; filter "
+ echo " -x filter defines filter if not using default "./vee-pre"; filter "
echo " must be executable, i.e., chmod 755 vee-pre "
echo " "
echo "Examples: "
@@ -189,9 +189,9 @@ CUSTOM_SETUP=default_setup
echo " "
echo "To delete a post forever: "
echo "1) delete the entry in the INDEX "
- echo "2) purge the entry: "
- echo " vee -p # make sure it is the one you want to purge"
- echo " vee -P # purge it!"
+ echo "2) purge the entry: "
+ echo " vee -p # make sure it is the one you want to purge "
+ echo " vee -P # purge it! "
echo " "
echo " brings up the latest entry as a vi sessions; when changes are save, "
echo " all messages are reformatted "
Please sign in to comment.
Something went wrong with that request. Please try again.