Debian Codegraph @

config/noterc

raw
1 # note 1.3.13 -*- sh -*-
2 #
3 # This is a sample config for the note script
4 # There are useful defaults set in note itself.
5 #
6 # Copy it to your $HOME as .noterc
7 #
8 # note is Copyright (c) 1999-2013 Thomas Linden.
9 # You can contact me per email: <tom at linden dot at>
10 #
11 # Comments start with #, empty lines will be ignored.
12 #
13 # To turn on an option, set it to: 1, on or yes
14 # To turn off an option, set it to: 0, off or no
15 #
16 # An option consists of an atribute-value pair separated
17 # by minimum one space (more spaces and/or tabs are allowed)
18 # and an optional equal sign in between.
19 #
20 # Variable names are case in-sensitive.
21 #
22 # Refer to the manpage to learn more about the config
23
24
25
26
27 #
28 # you need to decide which database backend you want
29 # to use. Please refer to the corresponding documentation
30 # for closer information about the certain backend!
31 # Currently supported types: "binary", "dbm", "mysql",
32 # "general", "dumper", "pwsafe3" or "text".
33 # You must also edit/uncomment one section below for the
34 # backend you want to use!
35 dbdriver = binary
36
37
38
39 #
40 # BINARY backend (the default)
41 binary::dbname = ~/.notedb # filename
42 binary::MaxNoteByte = 4096 # max bytes per note entry
43 binary::MaxTimeByte = 64 # max bytes for the date
44
45
46
47 #
48 # MYSQL backend
49 mysql::dbhost = localhost # hostname
50 mysql::dbport = 3306 # tcp port
51 mysql::dbuser = you # db login
52 mysql::dbpasswd = # db password
53 mysql::dbname = # database name (default: note)
54 mysql::encrypt_passwd = 0 # mysql::dbpasswd is
55 # encrypted (note --encrypt)
56
57
58 #
59 # DBM backend
60 dbm::directory = ~/.notedbm # directory
61
62
63
64 #
65 # GENERAL backend
66 general::dbname = ~/.notedb # filename
67
68
69 #
70 # TEXT backend
71 text::dbname = ~/.notedb # filename
72
73
74 #
75 # DUMPER backend
76 dumper::dbname = ~/.notedb # filename
77
78
79
80 #
81 # Password Safe v3 backend
82 # Some notes on this one:
83 # This backend maintains encryption itself, which is
84 # mandatory as well. So you'll have to disable encryption
85 # (UseEncryption = NO)!
86 #
87 # The Password Safe v3 file has its own fields for
88 # password and username, which note doesn't have. To be
89 # compatible, the pwsafe3 backend parses the note text
90 # for those fields and stores them accordignly to the db:
91 #
92 # For username field: user|username|login|account|benutzer
93 # For passwd field: password|pass|passwd|kennwort|pw
94 #
95 # If it doesn't find it, it will put empty strings
96 # into the pwsafe3 database.
97 #
98 # The pwsafe3 database can be accessed by Password Safe
99 # (see: http://passwordsafe.sourceforge.net/) or other
100 # tools which support the format (see:
101 # http://passwordsafe.sourceforge.net/relatedprojects.shtml)
102 pwsafe3::dbname = ~/db.psafe3 # filename
103
104
105 #
106 # You can use encryption with note, that means notes and
107 # timestamps will be stored encrypted. This is supported
108 # by every db-backend.
109 UseEncryption = NO
110
111
112
113 #
114 # Specify the encryption protocol. The appropriate perl
115 # module needs to be installed. Possible velues are
116 # IDEA, DES or Blowfish, the default is IDEA.
117 CryptMethod = IDEA
118
119
120
121 #
122 # You can run note always in interactive mode by simply
123 # typing "note". The default is: YES.
124 AlwaysInteractive = YES
125
126
127
128 #
129 # In interactive mode, note issues a list command if you
130 # simply hit enter. By turning this on, it will issue a
131 # longlist command instead if you hit just enter.
132 # The default is: NO
133 DefaultLong = NO
134
135
136
137 #
138 # You can use an external editor everytime from note instead
139 # of STDIN for creating new notes. The default is: YES
140 AlwaysEditor = YES
141
142
143
144 #
145 # By default, note looks in the environment for a variable
146 # $EDITOR or, if this is not the case, for $VISUAL and as
147 # fallback it uses 'vi'.
148 # You can override this by setting this variable here.
149 PreferredEditor =
150
151
152
153 #
154 # If you don't prefer that note updates the timestamp of a
155 # note after editing, turn this on. It will
156 # keep the original timestamp if this option is set.
157 # The default is: NO
158 KeepTimeStamp = NO
159
160
161
162 #
163 # You can specify your own topic separator here.
164 # The default topic separator is a normal slash: "/"
165 TopicSeparator = /
166
167
168
169 #
170 # The maximum width for displaying a note, in CHARS.
171 # Depends on your screen-size. You can set it to
172 # "auto", if you wish that note should determine the
173 # available size automatically.
174 MaxLen = auto
175
176
177
178 #
179 # Turn this off if you dont want note to automatically
180 # clear the screen after displaying something and after
181 # exit. The default is: NO
182 AutoClear = NO
183
184
185
186 #
187 # note can use colors for output, turn this of, if
188 # you don't like it, or if your terminal does
189 # not support it. The default is: YES
190 UseColors = NO
191
192
193
194 #
195 # Color-definitions of the various items. Will only
196 # take effect, if "UseColors" is turned on!
197 #
198 # The following colors are available:
199 # black, red, green, yellow, blue, magenta, cyan and white.
200 #
201 # For bold color write it uppercase (BLACK will be bold black).
202 # For underlined color append an underscore (blue_ will be underlined blue).
203 # For inverted color append an "I" (greenI will be inverted green).
204 BorderColor BLACK
205 NumberColor blue
206 NoteColor green
207 TimeColor black
208 TopicColor BLACK
209
210
211
212 #
213 # Additional to colors, you can also do a little bit of formatting your
214 # notes (bold, underlined, italic) text. The default is: YES.
215 FormatText = NO
216
217
218
219 #
220 # You might specify your own directory for temporary files.
221 # note needs to create some temp files during editing of notes.
222 # You could protect this directory using the command: chmod 700 directory.
223 # The default is: /tmp
224 TempDirectory = ~/tmp
225
226
227
228 #
229 # You can jump to a topic by typing "cd 13" in interactive mode.
230 # The deault is: NO
231 ShortCd = YES
232
233
234
235 #
236 # note can use a cached copy of the note database for list/tree/search
237 # this is currently only supported by the binary and the mysql backends,
238 # the general and text backends have an internal cache.
239 # The default is: NO
240 Cache = NO
241
242
243
244 #
245 # You can define your very own time format for time stamps
246 # YY - the last 2 digits of a year
247 # YYYY - year
248 # MM - month
249 # DD - day
250 # hh - hours
251 # mm - minutes
252 # ss - seconds
253 # This is the default: (18.10.2000 21:32:08)
254 TimeFormat = DD.MM.YYYY hh:mm:ss
255
256
257
258 #
259 # You can make note readonly which is useful for database copies
260 # The default is: NO
261 ReadOnly = NO
262
263
264
265 #
266 # Note may separate titles and topics using horizontal lines when
267 # listing them. You can turn on this behavior by setting
268 # PrintLines to YES.
269 # The default is: NO
270 PrintLines = NO
271
272
273
274 #
275 # Add a hash to identify notes. Such a hash will persist several
276 # importy/export cycles and makes each single note unique.
277 AddTicket = NO
278
279
280 #
281 # Show an entry on startup. If you want it, create such an entry
282 # and supply its number here
283 motd =
284
285
286 #
287 #
288 # That's all about it for now.
289 # If you still have any questiosn, please feel free to contact
290 # me by email: Thomas Linden <tom at linden dot at>
291 #
292 #