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,  directly
16       import  kjots  files,  cut  and  paste text or use an editor to convert
17       other text files to the simple gjots2 format (see below  for  details).
18       You  can  also convert an existing DOCBOOK file into gjots2 format with
19       docbook2gjots(1).
20
21       gjots2 files can be simply converted into HTML using  gjots2html(1)  or
22       into DOCBOOK with gjots2docbook(1)
23
24       Sensitive  data  can  be  encrypted  by ccrypt(1), openssl(1) or gpg(1)
25       simply by saving with  an  appropriate  file  suffix  and  providing  a
26       password:
27
28              ccrypt
29                         .cpt
30
31              openssl
32                         .ssl
33
34              gpg
35                         .gpg
36
37       Don't  forget  your  passwords.  Obviously,  the appropriate encryption
38       utility must have been installed.
39
40       Simple  text  formatting  is  provided  with  the  usual  cut  &  paste
41       operations  and  paragraph  formatting (line wrapping) according to the
42       line length set  in  Settings->Preferences.   Lines  are  formatted  by
43       pressing  the Wrap button or ^L. This requires the fmt(1) command which
44       is in the sys-apps/textutils pacakge (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              Produces  a  trace  of  program  execution  possiby  useful   in
74              debugging
75
76       -V, --version
77              Print the version and quit
78

FILES

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

FILE FORMAT

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

EXAMPLE

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

AUTHOR

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

COPYRIGHT

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