updated on Sun Jan 22 08:00:21 UTC 2012
[aur-mirror.git] / nn / config.h
blobf037b6fc064965929de2978ba91be7ac75fb0874
1 /**************************** NN CONFIGURATION ***************************
3 * Configuration file for nn.
5 * You must edit this file to reflect your local configuration
6 * and environment.
8 * Before editing this file, read the licence terms in the README
9 * file and the installation guidelines in the INSTALLATION file.
11 * (c) Copyright 1990, Kim F. Storm. All rights reserved.
17 * The Good Net-Keeping Seal of Approval folks seem to think it necessary to
18 * waste screen real estate with headers. For such people, uncomment the
19 * following to change the default headers
22 /* #define GNKSA */
25 /************************* NOV CONFIGURATION ******************************
27 * Define USE_SPOOL if you want to be able to read directly on a news
28 * spool. You may have to also correct NOV_DIRECTORY NOV_FILENAME and
29 * NEWS_DIRECTORY settings to match your local Spool-Configuration.
31 * Define NOV if you have access to .overview files in your news spool
32 * area and you want to use them rather than run nnmaster.
33 * If you use NNTP and your server is INN 1.4 or later with XOVER support
34 * and is generating .overview files there, you can use NOV over NNTP. In
35 * that case, make sure you define NNTP below as well.
37 * If your NOV implementation doesn't have records for digests (none
38 * that I know of do), you might want to define 'DO_NOV_DIGEST'.
39 * This will cause nn to grab a digest article and split it apart
40 * before anything has been selected to be read from that article.
41 * 'DO_NOV_DIGEST' is necessary if you want any digests (like
42 * 'comp.risks') to be automatically split.
44 * NOV_DIRECTORY and NOV_FILENAME can normally be left undefined.
47 /* Optional */
48 /* #define USE_SPOOL */
50 #define NOV
52 /* Optional */
53 #define DO_NOV_DIGEST
55 /* Optional */
56 /* #define NOV_DIRECTORY "/usr/spool/news" */
58 /* Optional */
59 /* #define NOV_FILENAME ".overview" */
62 /********************************** NNTP *********************************
64 * Define NNTP to enable nntp support. If you are not using NNTP,
65 * just leave the following NNTP_* definitions as they are - they
66 * will be ignored anyway.
69 #define NNTP
72 * Define NNTP_SERVER to the name of a file containing the name of the
73 * nntp server (aka the newsserver you connect to).
75 * If the file name does not start with a slash, it is relative to
76 * LIB_DIRECTORY defined below.
79 #define NNTP_SERVER "/etc/news/server"
82 * Define your local domain name. If you leave this undefined, nn will
83 * attempt to discover it.
84 * See comment below on HIDDENNET.
87 /* #define DOMAIN "frobozz.bogus" */
90 * If you define HIDDENNET, the hostname will not appear in the posting
91 * data except on the path. Items will be from user@DOMAIN (with
92 * DOMAIN as defined above). If you don't want this, comment it out.
95 #define HIDDENNET
98 /***************** OPERATING SYSTEM DEPENDENT DEFINITIONS *******************
100 * Include the appropriate s- file for your system below.
102 * If a file does not exist for your system, you can use
103 * conf/s-template.h as a starting point for writing you own.
106 #include "s-linux.h"
109 * Define DEFAULT_PAGER as the initial value of the 'pager' variable.
110 * nnadmin pipes shell command output though this command.
113 /* #define DEFAULT_PAGER "pg -n -s" */ /* System V */
114 #define DEFAULT_PAGER "less"
117 * DEFAULT_PRINTER is the initial value of the 'printer' variable.
118 * nn's :print command pipes text into this command.
121 /* #define DEFAULT_PRINTER "lp -s" */ /* System V */
122 #define DEFAULT_PRINTER "lpr -p -JNEWS" /* bsd */
125 /********************** MACHINE DEPENDENT DEFINITIONS **********************
127 * Include the appropriate m- file for your system below.
129 * If a file does not exist for your system, you can use
130 * conf/m-template.h as a starting point for writing you own.
133 #include "m-i80386.h"
136 /***************************** OWNERSHIP ***************************
138 * Specify owner and group for installed files and programs.
140 * The nnmaster will run suid/sgid to this owner and group.
142 * The only requirements are that the ownership allows the
143 * nnmaster to READ the news related files and directories, and
144 * the ordinary users to read the database and execute the nn*
145 * programs.
147 * Common choices are: (news, news) and (your uid, your gid)
150 #define OWNER "root"
151 #define GROUP "root"
154 /**************************** LOCALIZATION ****************************
156 * Specify where programs and files are installed.
158 * BIN_DIRECTORY - the location of the user programs (mandatory)
160 * LIB_DIRECTORY - the location of auxiliary programs and files.
161 * (mandatory UNLESS ALL of the following are defined).
163 * MASTER_DIRECTORY - the location of the master program (on server)
164 * (= LIB_DIRECTORY if undefined)
166 * CLIENT_DIRECTORY - the location of auxiliary programs (on clients)
167 * (= LIB_DIRECTORY if undefined)
169 * HELP_DIRECTORY - the location of help files, online manual, etc.
170 * (= CLIENT_DIRECTORY/help if undefined)
172 * CACHE_DIRECTORY - if NNTP is used, nn uses this central directory
173 * to store working copies of articles on the local
174 * system. If not defined, it stores the articles
175 * in each user's ~/.nn directory.
177 * TMP_DIRECTORY - temporary file storage. Overriden by $TMPDIR.
178 * (= /var/tmp if undefined).
180 * LOG_FILE - the location of nn's log file.
181 * (= $HOME/.nn/Log if undefined).
184 #define BIN_DIRECTORY "/usr/bin"
185 #define LIB_DIRECTORY "/usr/lib/nn"
190 /*************************** MAIL INTERFACE *************************
192 * Specify a mailer that accepts a letter WITH a header IN THE TEXT.
194 * A program named 'recmail' program is normally delivered with
195 * the Bnews system, or you can use sendmail -t if you have it.
197 * The contrib/ directory contains two programs which you might
198 * be able to use with a little tweaking.
201 /* #define REC_MAIL "/usr/lib/news/recmail" */ /* non-sendmail */
202 #define REC_MAIL "/usr/lib/sendmail -t" /* sendmail */
206 * nn needs to know the name of your host.
207 * To obtain the host name it will use either of the 'uname' or
208 * 'gethostname' system calls as specified in the s-file included
209 * above.
211 * If neither 'uname' nor 'gethostname' is available, you must
212 * define HOSTNAME to be the name of your host. Otherwise, leave
213 * it undefined (it will not be used anyway).
216 /* #define HOSTNAME "myhost" */
219 * Define APPEND_SIGNATURE if you want nn to ask users to append
220 * ~/.signature to mail messages (reply/forward/mail).
222 * If the mailer defined in REC_MAIL automatically includes .signature
223 * you should not define this (it will fool people to include it twice).
225 * I think 'recmail' includes .signature, but 'sendmail -t' doesn't.
228 #define APPEND_SIGNATURE
231 * BUG_REPORT_ADDRESS is the initial value of the bug-report-address
232 * variable which is used by the :bug command to report bugs in
233 * the nn software.
236 #define BUG_REPORT_ADDRESS "mtpins@nndev.org"
239 /*************************** DOCUMENTATION ***************************
241 * Specify directories for the user and system manuals
243 * Adapt this to your local standards; the manuals will be named
244 * $(MAN_DIR)/program.$(MAN_SECTION)
246 * USER_MAN - nn, nntidy, nngrep, etc.
247 * SYS_MAN - nnadmin
248 * DAEMON_MAN - nnmaster
251 #define USER_MAN_DIR "/usr/share/man/man1"
252 #define USER_MAN_SECTION "1"
254 #define SYS_MAN_DIR "/usr/share/man/man1"
255 #define SYS_MAN_SECTION "1m"
257 #define DAEMON_MAN_DIR "/usr/share/man/man8"
258 #define DAEMON_MAN_SECTION "8"
261 /************************** LOCAL POLICY *****************************
263 * Define STATISTICS if you want to keep a record of how much
264 * time the users spend on news reading.
266 * Sessions shorter than the specified number of minutes are not
267 * recorded (don't clutter up the log file).
269 * Usage statistics is entered into the $LOG_FILE with code U
272 /* #define STATISTICS 5 */ /* minutes */
275 * Define ACCOUNTING if you want to keep accumulated accounting
276 * based on the statistics in a separate 'acct' file. In this
277 * case, the accounting figures will be secret, and not be
278 * written to the Log file. And the users will not be able to
279 * "decrease" their own account.
281 * See account.h for optional cost calculation parameters.
284 /* #define ACCOUNTING */
287 * Define AUTHORIZE if you want to restrict the use of nn to
288 * certain users or certain periods of the day. Define both
289 * this and ACCOUNTING if you want to impose a usage quota.
291 * See account.h for implementing various access policies.
294 /* #define AUTHORIZE */
297 * Default folder directory
300 #define FOLDER_DIRECTORY "~/News"
303 * Default length of authors name (in "edited" format).
304 * Also size of "Name" field on the article menus.
305 * The actual value used will be the larger of this and 1/5 the width
306 * of the window.
309 #define NAME_LENGTH 16
312 * SIGN_TYPE is the program to be used to create digital signatures.
315 #define SIGN_TYPE "gpg"
316 /* #define SIGN_TYPE "pgp" */
319 * If no "Lines:" header field is present, NN can be made to
320 * count them itself.
323 #define DONT_COUNT_LINES
326 * PUT_TIMESTAMP_IN_SCRIPTS
327 * Defining this causes the "inst" script to add identifying information
328 * to the beginning of the shell scripts.
331 #define PUT_TIMESTAMP_IN_SCRIPTS
334 * CONFIG_NUM_IN_VERSION
335 * Defining this will make NN announce itself including the build number
336 * like "NN version 6.7.x #12", rather than "NN version 6.7.x".
339 /* #define CONFIG_NUM_IN_VERSION */
342 * ART_GREP
343 * Define this if you want to enable the "experimental" subject
344 * body search code. On the "G" menu, there will be two extra
345 * choices: "b" body search unread, and "B" body search all.
346 * Choose your pattern, and you will be presented with a merged group
347 * containing the articles you chose. There may still be bugs!
348 * WARNING:
349 * THIS WOULD BE *BAD* FOR NNTP SITES! You don't want all your
350 * users downloading the entire news database...
353 /* #define ART_GREP */
356 * CACHE_PURPOSE
357 * Defining this makes NN cache the newsgroup/purpose list, sorted
358 * in memory and use binary search to locate a group's purpose.
359 * This can be a winner on systems with *everything* in their
360 * newsgroups list. Note that this will cause nn to always download
361 * the newsgroup/purpose list. This will increase startup time for nn
362 * but is still a win for people who have show-purpose-mode=2.
363 * Currently CACHE_PURPOSE and nnmaster don't work together,
364 * so please leave this undefined unless you are using NOV.
367 /* #define CACHE_PURPOSE */
370 * If you aren't running nnmaster you can stop here.
373 /************************ NNMASTER CONFIGURATION *************************/
375 /*********************** NETWORK DEPENDENT DEFINITIONS **********************
377 * Define NETWORK_DATABASE if you share the database through NFS on
378 * a network with different, non-compatible machines, e.g. SUNs and
379 * VAXen, or SUN-3 and SUN-4, or if you are using different compilers
380 * on the same architecture.
382 * In a homogenous network, you can leave it undefined for higher
383 * performance (no data conversion is needed).
386 /* #define NETWORK_DATABASE */
389 /**************************** DATABASE LOCATION **************************
391 * Specify where the nn database should be installed.
393 * If none of the following symbols are defined, the database will
394 * be contained in the NEWS_DIRECTORY in a separate .nn directory for
395 * master files and in files named .nnx and .nnd in each group's
396 * spool directory. To use this scheme, the OWNER specified above
397 * must have write permission on the news spool directories.
399 * If you access news via NNTP, you will probably always have to
400 * give the database directory explicitly through DB_DIRECTORY
401 * (and DB_DATA_DIRECTORY), since the normal news spool directories
402 * are probably not available on the local system.
403 * The exception may be if nnmaster runs directly on the nntp server.
405 * To change the default behavior, you can define the following
406 * symbols:
408 * DB_DIRECTORY - the directory containing the master files.
410 * DB_DATA_DIRECTORY - the directory containing the per-group files
411 * (default is DB_DIRECTORY/DATA if undefined).
413 * DB_LONG_NAMES - use group's name rather than number when
414 * building file names in DB_DATA_DIRECTORY.
415 * (The file system must support long file names!!)
418 /* #define DB_DIRECTORY "/usr/spool/nn" */
421 /*************************** NEWS TRANSPORT **************************
423 * Specify the location of your news programs and files
424 * You only need to specify these if you are not
425 * satisfied with the default settings.
427 * NEWS_DIRECTORY - The news spool directory.
428 * Default: /usr/spool/news
430 * NEWS_LIB_DIRECTORY - The news lib directory.
431 * Default: /usr/lib/news
433 * RMGROUP_PATH - The location of the rmgroup program.
434 * Default: NEWS_LIB_DIR/{rm,del}group
437 /* #define NEWS_DIRECTORY "/usr/spool/news" */
438 /* #define NEWS_LIB_DIRECTORY "/usr/lib/news" */
440 /************************ CONFIGURATION COMPLETED ************************/