gjots2(1)

1GJOTS2(1)                   General Commands Manual                  GJOTS2(1)
2
3
4

NAME

6       gjots2 - A gnome-2/X11 jotter
7

SYNOPSIS

9       gjots2 [options] gjotsfile
10

DESCRIPTION

12       gjots2  is  a  fairly  simple  jotter  application for your desktop. It
13       displays your data organised in a tree with each leaf being your text.
14
15       Getting data into gjots2 is fairly easy - you can type it in,  cut  and
16       paste  text  or use an editor to convert other text files to the simple
17       gjots2 format (see below for details). You can also convert an existing
18       DOCBOOK file into gjots2 format with docbook2gjots(1).
19
20       gjots2  files  can be simply converted into HTML using gjots2html(1) or
21       into DOCBOOK with gjots2docbook(1)
22
23       Sensitive data can be encrypted  by  ccrypt(1),  openssl(1)  or  gpg(1)
24       simply  by  saving  with  an  appropriate  file  suffix and providing a
25       password:
26
27              ccrypt
28                         .cpt
29
30              openssl
31                         .ssl
32
33              gpg
34                         .gpg
35
36       Don't forget your  passwords.  Obviously,  the  appropriate  encryption
37       utility must have been installed.
38
39       Simple  text  formatting  is  provided  with  the  usual  cut  &  paste
40       operations and paragraph formatting (line wrapping)  according  to  the
41       line  length  set  in  Settings->Preferences.   Lines  are formatted by
42       pressing the Wrap button or ^L. This requires the fmt(1) command  which
43       is  in  the  coreutils  package in fedora and in the sys-apps/textutils
44       directory on Gentoo.
45
46       An external editor (configured in Settings->Preferences) can be invoked
47       by  pressing  the Ext.Ed button.  gjots2 is suspended while the editing
48       is carried on.
49
50       File locking is implemented by a  lockfile  (.#filename)  in  the  same
51       directory  as  the  file being edited. Multiple users can open the file
52       readonly but only one user can open the file  for  writing.  Since  the
53       locking  is  done  with  a  lockfile  even  NFS-mounted  files  can  be
54       protected.
55

OPTIONS

57       --help Prints help.
58
59       -g, --geometry WIDTHxHEIGHT[+X+Y]
60              Initial window geometry for gjots2.   Note  that  the  X  and  Y
61              components are presently ignored.
62
63       -p, --purge-password
64              When opening an encrypted file, gjots now remembers the password
65              for subsequent writes. To restore the old behaviour where  gjots
66              purged the password, use this option.
67
68       -r, --readonly
69              Opens  the  gjotsfile  in  readonly mode (with no locking and no
70              ability to write)
71
72       -d, --debug
73              debug to stdout
74
75       -t, --trace
76              trace lines as they execute
77
78       -V, --version
79              Print the version and quit
80

FILES

82       $HOME/.gjotsfile The default data file
83
84       `dirname filename`/.#`basename filename`
85              The lock file for the file called filename.
86

FILE FORMAT

88       gjots2 uses a simple text file format with the addition of a  hierarchy
89       of  items  introduced by keywords. The keywords need to be at the start
90       of line to be recognised. Only 3 keywords are presently used:
91
92       \NewEntry      Starts a new entry
93
94       \NewFolder     Promotes the current item to a folder
95
96       \EndFolder     Ends a folder
97
98       The first line in every entry is used as the 'title' for the tree.
99
100       In a future release the \Option keyword may be added.
101

EXAMPLE

103       \NewEntry
104       title1
105       this is the stuff that goes into title1
106
107       \NewFolder
108       \NewEntry
109       title3
110       title 3's stuff
111
112       \EndFolder
113

AUTHOR

115       Written by Bob Hepple <bhepple@freeshell.org>
116
117       http://bhepple.freeshell.org/gjots
118

COPYRIGHT

120       Copyright (c) 2002-2011 Robert Hepple
121       This is free software; see the source for copying conditions. There  is
122       NO  warranty;  not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR
123       PURPOSE.
124