wiki

A personal commandline wiki.
git clone git://r-36.net/wiki
Log | Files | Refs | README | LICENSE

README.md (1137B)

      1 # Wiki – Personal Wiki
      2 
      3 This is a local wiki you edit and manage just using the commandline.
      4 
      5 ## License
      6 See LICENSE.
      7 
      8 ## Dependencies
      9 * git for change management
     10 
     11 ## Installation
     12 
     13 	% git clone git://r-36.net/wiki
     14 	% cd wiki
     15 	% cp wiki $HOME/bin
     16 	% mkdir -p $HOME/.psw
     17 	# psw – personal wiki
     18 	% cd $HOME/.psw
     19 	% git init
     20 
     21 ## The Base
     22 If  you  want  to have different wikis, use the ‐b parameter to define a
     23 different directory where the wiki pages are managed. The default is the
     24 above mentioned »~/.psw«.
     25 
     26 	% wiki -b $HOME/.someotherwiki somecommand
     27 
     28 Of course do not forget to git init this directory.
     29 
     30 ## Add A Page
     31 
     32 	% wiki -e page
     33 
     34 ## Delete A Page
     35 
     36 	% wiki -d page
     37 
     38 ## Search The Pages
     39 
     40 	% wiki -s searchterm
     41 
     42 ## Rename Some page
     43 
     44 	% wiki -r fromname toname
     45 
     46 ## Display Page To Stdout
     47 
     48 	% wiki -o page
     49 
     50 ## List All Pages
     51 
     52 	% wiki -l
     53 
     54 ## Commit If Manual Changes
     55 If you changed something by hand in the wiki directory, run:
     56 
     57 	% wiki -c
     58 
     59 
     60 ## Commandline Completion
     61 
     62 	% wiki -e <tab>
     63 
     64 For a way to handle this, see the »completion« directory.
     65 
     66 
     67 
     68 ## Bug Reports
     69 
     70 	All to:
     71 
     72 		Christoph Lohmann <20h@r-36.net>
     73 
     74 Have fun!
     75 
     76 20h
     77