Debian Codegraph @

config/rc

raw
1 comments start with #, empty lines will be ignored.
2 1 turns an option on, 0 turns it off.
3 An option consists of an atribute-value pair separated
4 by minimum one space (more spaces and/or tabs are allowed)
5
6
7 Your home directory, better do not change it!
8 can be an environment variable or a path
9 Home $ENV{'HOME'}
10
11
12 specify the path, where the NOTEDB lib directory
13 resides. This will only used if it is not
14 installed inside the perl-lib directory structure!
15 LibPath /usr/local/lib
16
17
18 you need to decide which database backend you want
19 to use. Please refer to the corresponding documentation
20 for closer information about the certain backend!
21 Currently supported types: "binary", "dbm" or "mysql".
22 You must also edit/uncomment one section below for the
23 backend you want to use!
24 DbDriver binary
25
26
27 backend specific settings for sql backend
28 DbHost localhost
29 DbUser you
30 DbPasswd
31 DbName mynotes
32 DbTable note
33 FieldNumber number
34 FieldNote note
35 FieldDate date
36 use an encrypted password, generate it with note "--encrypt_passwd"
37 encrypt_passwd 1
38 #### specific end ###
39
40
41 backend specific settings for binary(default) backend
42 NoteDb ~/.notedb
43 Define the maximum bytes fields can have in a
44 note-entry. Do not change MaxTimeByte to less than 64!
45
46 MaxNoteByte 4096
47 MaxTimeByte 64
48 #### specific end ###
49
50
51 backend specific settings for DBM backend
52 this must be an existing directory!
53 #DbName /home/you/.notedbm
54 #### specific end ###
55
56 You can use encryption with note, that means notes and
57 timestamps will be stored encrypted. This is supported
58 by every db-backend.
59 Set to 1 to turn it on. The Default is 0 (off)
60 UseEncryption 0
61
62 Specify the encryption protocol. The appropriate perl
63 module needs to be installed. Possible velues are
64 IDEA, DES or Blowfish, the default is IDEA.
65 CryptMethod IDEA
66
67
68 You can run note always in interactive mode by simply
69 typing "note". Set this option to 1 to turn it on.
70 The default is 0 (off).
71 AlwaysInteractive 0
72
73
74 In interactive mode, note issues a list command if you
75 simply hit enter. By turning this on, it will issue a
76 longlist command instead if you hit just enter.
77 The default is 0 (off)
78 DefaultLong 0
79
80
81
82 You can use an external editor everytime from note instead
83 of STDIN for creating new notes. Set to 1 to turn it on.
84 The default is 0 (off).
85 AlwaysEditor 0
86
87
88 uncomment and edit it, if you want to use another
89 editor than the default $EDITOR or as fallback vi.
90 #PreferredEditor emacs
91
92
93 If you dont prefer that note updates the timestamp of a
94 note after editing, turn this on. It will
95 keep the original timestamp if this option is set.
96 The default is 0(off), to turn it on set to 1.
97 KeepTimeStamp 0
98
99
100 You can specify your own topic separator here.
101 the default topic separator is a normal slash: "/"
102 see README for details about topics!
103 TopicSeparator /
104
105
106 The maximum width for displaying a note, in CHARS.
107 Depends on your screen-size. You can set it to
108 "auto", if you wish that note sould determine the
109 available size, but it experimental, be aware!
110 MaxLen 30
111
112
113 note can use colors for output, set this option to
114 1, if you don't want it, or if your terminal does
115 not support it, set to 0. The default is 1 (on).
116 UseColors 1
117
118
119 Color-definitions of the various items. Will only
120 take effect, if "UseColors" is turned on!
121 BorderColor BLACK
122 NumberColor blue
123 NoteColor green
124 TimeColor black
125 TopicColor BLACK
126 The following colors are available:
127 black, red, green, yellow, blue, magenta, cyan and white.
128 for bold color write it uppercase (BLACK will be bold black)
129 for underlined color append an underscore (blue_ will be underlined blue)
130 for inverted color append an "I" (greenI will be inverted green)
131
132
133 Additional to colors, you can also do a little bit of formatting your
134 notes (bold, underlined, italic), see README!
135 You need to set this Option to 1, if you decide to make use of this
136 capabily
137 FormatText 1
138
139
140 You might specify your own directory for temporary files.
141 note needs to create some temp files during editing of notes.
142 You could protect this directory using the command: chmod 700 directory.
143 The default is /tmp
144 TempDirectory /home/you/tmp
145
146
147
148 You can jump to a topic by typing "cd 13" in interactive mode.
149 You need to set thi soption to 1 if you want to use this feature.
150 ShortCd 0
151
152 That's all about it for now.
153 If you still have any questiosn, please feel free to contact
154 me by email: Thomas Linden <[email protected]>