From: Mark Szymanski Date: Sun, 5 Dec 2010 23:06:04 +0000 (-0600) Subject: Improved ref documentation X-Git-Url: https://source.supwisdom.com/gerrit/gitweb?a=commitdiff_plain;h=862c6438f4659c3755c0a4d64f17e0e15d129cae;p=common%2Fbash_it.git Improved ref documentation --- diff --git a/plugins/ref.plugin.bash b/plugins/ref.plugin.bash index d5888db..34f744c 100644 --- a/plugins/ref.plugin.bash +++ b/plugins/ref.plugin.bash @@ -18,6 +18,29 @@ # # # This is what the basic structure of your $REF_DIR should look like: Subdirectories for each subject, and then another set of subdirectories for the part of the # # subject you want to reference. And in the second subdirectory, an index.html file. # +# +# To use ref, you do the ref command followed by the sugject and the sub-subject as arguments. For instance: +# +# ref bash array +# +# Would open the bash/array/index.html file. +# +# To list your references, you would do the ref ls command, optionally followed by a subject. For instance: +# +# ref ls +# +# Would give me: +# +# ruby bash +# +# And: +# +# ref ls bash +# +# would output: +# +# array +# select # # # I hope that you like this plugin and if you have any questions about it, send me (mrman208) a message on GitHub or email me at mrman208@me.com # #####################################################################################################################################################################