Debian Codegraph @

upstream/debian-unstable/man1/lmove.1

raw
1 .\" $Revision: 3.10.4 $
2 .TH LMOVE 1
3 .SH NAME
4 lmove - move articles into /news/group/number directories
5 .SH SYNOPSIS
6 .I lmove
7 .BI
8 -d directory
9 [
10 .BI
11 -c filename
12 ]
13 [
14 .BI
15 -a filename
16 ]
17 [
18 .BI
19 -e | -E filename
20 ]
21 [
22 .BI
23 -l phrase_file
24 ]
25 [
26 .BI
27 -D
28 ]
29 [
30 .BI
31 -A
32 ]
33 [
34 .BI
35 -h | -s
36 ]
37
38 .SH OPTIONS
39
40 \-a filename
41
42 This is the location of the active file. See description of file below.
43 If this option is not provided, the default of "active" is used.
44
45 \-A
46
47 Lmove uses the active file to determine what number to start at when
48 creating the file name for the articles in each group. If an external
49 program or person either puts articles into the directories, or changes
50 the numbers in the active file, the possibility exists to accidently
51 overwrite already existing articles. In order to avoid this, lmove
52 checks to see if an article already exists before moving a new article
53 into the directory tree. If it already exists, then lmove aborts with
54 a warning message at that point.
55
56 This option overrides the default action. If this option is given when
57 lmove runs, then lmove will keep increasing the article number until
58 it finds one not being used.
59
60 \-c filename
61
62 This is the location of the configuration file. See description of file below.
63 If this option is not provided, the default of "lmove-config" is used.
64
65 \-d directory
66
67 This option is required. This is the directory that contains the articles
68 for lmove to put into the directory structure. It should be on the same
69 filesystem as the BASE directory (see ACTIVE FILE below), since some ..IX's
70 move command can not move files across file systems.
71
72 \-D
73
74 This option tells lmove to log various debugging messages to debug.suck. This is
75 primarily used by the developer to trace various problems.
76
77 \-e | \-E filename
78
79 These options will send all error messages (normally displayed on stderr), to
80 an alternate file. The lower case version, -e, will send the error messages
81 to the compiled-in default defined in suck_config.h.
82 The upper case version, -E, requires the filename parameter. All error messages
83 will then be sent to this file.
84
85 \-l phrase_file
86
87 This option tells lmove to load in an alternate phrase file, instead of using
88 the built-in messages. This allows you to have lmove print phrases in another
89 language, or to allow you to customize the messages without re-building lmove.
90 See the "FOREIGN LANGUAGE PHRASES" in suck.1 for more details.
91
92 \-s
93
94 This option tells suck to create symbolic links for articles that are cross
95 posted to multiple groups. The first group on the newsgroups line that
96 is in the active file gets the actual text of the article, any other groups
97 that are on the newsgroups line that also exist in the active file will get
98 symbolic links to the actual text. This is so that news readers can see
99 cross posted articles in all the groups that they were cross posted to.
100 NOTE: If an article is cross posted to a group that does not exist in the
101 active file, then a link will not be created.
102
103 \-h
104
105 This option is identical to the -s option, but instead of symbolic links,
106 hard links are created. See man 2 link and man 2 symlink to explain the
107 differences between hard and symbolic links.
108
109 .SH DESCRIPTION
110
111 Lmove will take articles in a single directory (such as those retrieved with
112 "suck" ), and put them into a directory tree based on newsgroups. Lmove uses
113 an "active" file to determine where to put the various articles, and to keep
114 track of the highest numbered articles in these directories. Lmove will scan
115 each article to find a matching group in the active file, then store the
116 article in that group's directory, increasing the highest number for that
117 group. Normally, once the first group of an article is matched in the active file,
118 lmove goes on to the next article, unless you use the -h or -s option above.
119
120 .SH CONFIGURATION FILE
121
122 The configuration file should contain two lines:
123
124 .RS
125 BASE=/usr/spool/news
126 .RE
127 .RS
128 ACTIVE=/usr/spool/news/active
129 .RE
130
131 The BASE= tells lmove the base directory for all articles. This is where
132 the articles are actually stored.
133
134 The ACTIVE= tells lmove where to find the active file, described below.
135
136 .SH ACTIVE FILE
137
138 The active file consists of newsgroup names, the current highest article number,
139 the current lowest article number, and the current status of the group. Lmove
140 only uses the newsgroup name and highest article number. The other fields are
141 just rewritten, and not modified in any way. These are here for use by other
142 programs.
143
144 Example:
145
146 .RS
147 comp.os.linux.announce 1000 1 y
148 .RE
149
150 The lines are a listing of the valid groups that lmove will
151 store articles in. The highest article number for a new group should be
152 either 0 or 1.
153
154 Upon completion, lmove will move the current active file to "active.old",
155 and write out a new active file with the new highest article numbers.
156 Any articles not moved into the directory structure are left in the original
157 article directory.
158
159 .SH EXIT VALUES
160 0 on success, -1 on failure.
161 .de R$
162 Revision \\$$3, \\$$4
163 ..
164 .SH "SEE ALSO"
165 suck(1), rpost(1), testhost(1).