gumnut Usage Tutorial

Contents


1.  Setting up
2.  Starting gumnut
3.  gumnut Command Line Args
4.  Commands
5.  Displaytree format


1.  Setting up
--------------


 *** Setting up is now automatic. Can go straight to step 2 ***

#
#
#The gumnut-setup script needs to be run before the first use. It will set up
#the required share directories (in ~/gumnut/) and create a default config
#file (~/.gnutrc)
#
# - installed from source tarball
#
#$ gumnut-VERSION/gumnut-setup
#
#
# - installed from .deb package
#
#$ gumnut-setup
#
#

2.  Starting gumnut
-------------------

 - installed from source tarball

$ gumnut-VERSION/src/gumnut


 - installed from .deb package

$ gumnut



3.  gumnut Command Line Args
----------------------------

-L   LAN usage       attempt to connect to the IP range 192.168.0.*

-I   Internet usage  attempt to connect to an online instance or host cache
                     at gumnut.dyndns.org:5634 to find the gumnut network cloud.



4.  Commands
------------

create            Creates a new idea in a leaf on the local node.
                  Prompting for the required fields.

remove [N]        Deletes the currently displayed leaf or the leaf
                  specified by N. This leaf will no longer be shared
		  on the network and will thus decrease it's moderation
		  weighting by 1.

reply [N]         Replies to the currently displayed leaf or the
                  leaf specified by N.

mirror [N]        Mirrors the currently displayed leaf or the leaf
                  specified by N. This will download the remote leaf
		  and share it out on the network in ~/gumnut/branches.
		  Mirroring is the method of indicating agreement with
		  the contents of the remote leaf.

find [query]      Finds leafs on the network which contain the string
                  included in "query". Multiple fields may be searched
		  on by creating a space delimited query string. [the 
		  query needs to be 4 or more characters in length]

displaytree [N]   Displays the leafs from the previous call to "find". Showing
                  the contents of the specified leaf. The display format is
		  leaf number, moderation weighting, location and filename.

forward           Shows the contents of the next leaf in a displaytree list.
                  Can be abbreviated to 'f'.

backward          Shows the contents of the previous leaf in a displaytree list.
                  Can be abbreviated to 'b'.

redisplaytree     Displays the leafs from the previous "find" and "displaytree"
                  calls.

threshold [N]     Shows the current minimum moderation weighting required to
                  display a leaf. If N is specified, the threshold will be
		  reset to this value.

lanconnect        Opens connections to any gumnut instances in the range
                  192.168.0.*

netconnect        Opens a connection to a known Internet hostname which will
                  be running a gumnut instance or a hostcache. This is the
		  current way of finding the online gumnut network cloud.

branches          Displays all the locally stored leafs which are shared on the
                  network.

info              Displays other currently connected servents.

help [command]    Display a summary list of all commands. If 'command' is
                  specified help will be displayed for that command only.





5. Displaytree format
---------------------

06-03 L  ----LEAF_tS20051123102124_pLearth_cCau_pC6000_cTjjfam_tOpicnic261105_sJdestination_tD01r02r01.txt

/\ /\ ^  /--\/------------\
|| || |  |  ||            |
|| || |  |  |XXXXXXXXXX...N <---- the filename of the leaf.
|| || |  |  |
|| || |  XXXX <------------------ the reply depth indent to graphically
|| || |                           depict which leafs are replies to others
|| || |
|| || X <------------------------ the leaf's location.  L indicates it is
|| ||                             stored on the local node and shared to
|| ||                             the network, R indicates it does not exist
|| ||                             locally and is on a remote node
|| ||
|| XX <-------------------------- the number of instances found on the
||                                whole network. This indicates the leafs 
||                                moderation weighting (in this case a
||                                weighting of 3)
||
XX <----------------------------- the leaf number of the response
                                  (in this case, leaf number 6 in the list)