1 | .\"------------------------------------------------------------
|
---|
2 | .\" Id - set Rv,revision, and Dt, Date using rcs-Id tag.
|
---|
3 | .de Id
|
---|
4 | .ds Rv \\$3
|
---|
5 | .ds Dt \\$4
|
---|
6 | ..
|
---|
7 | .Id $Id: mg_get_merge.1 3745 2003-02-20 21:20:24Z mdewsnip $
|
---|
8 | .\"------------------------------------------------------------
|
---|
9 | .TH mg_get_merge 1 \*(Dt CITRI
|
---|
10 | .SH NAME
|
---|
11 | mg_get_merge \- output source texts for processing
|
---|
12 | .SH SYNOPSIS
|
---|
13 | .B mg_get_merge
|
---|
14 | .I collection-name
|
---|
15 | .if n .ti +9n
|
---|
16 | [
|
---|
17 | .BR \-init " |"
|
---|
18 | .BR \-i " |"
|
---|
19 | .BR \-text " |"
|
---|
20 | .BR \-t " |"
|
---|
21 | .BR \-cleanup " |"
|
---|
22 | .B \-c
|
---|
23 | ]
|
---|
24 | .SH DESCRIPTION
|
---|
25 | This program is the default one used by
|
---|
26 | .BR mgmerge (1)
|
---|
27 | to generate the source text for new documents to appended to
|
---|
28 | an
|
---|
29 | .BR mg (1)
|
---|
30 | system database.
|
---|
31 | Its function is exactly the same as
|
---|
32 | .BR mg_get (1)
|
---|
33 | except that it generates the
|
---|
34 | .I new
|
---|
35 | documents to be added to an
|
---|
36 | .BR mg (1)
|
---|
37 | system database that has already been built using
|
---|
38 | .BR mgbuild(1).
|
---|
39 | Any program may be used to generate the source
|
---|
40 | text for
|
---|
41 | .BR mgmerge (1),
|
---|
42 | as long as it confirms to the interface specified
|
---|
43 | here.
|
---|
44 | .SH OPTIONS
|
---|
45 | The
|
---|
46 | .I collection-name
|
---|
47 | must appear before any other option. Only the first option has any
|
---|
48 | significance. If no option is specified,
|
---|
49 | .B \-text
|
---|
50 | is assumed.
|
---|
51 | .TP "\w'\fB\-cleanup\fP and \fB\-c\fP'u+2n"
|
---|
52 | .BR \-init " and " \-i
|
---|
53 | The program is called once with this flag at the start of merging a
|
---|
54 | collection.
|
---|
55 | .TP
|
---|
56 | .BR \-text " and " \-t
|
---|
57 | The program is called with this flag multiple times during the
|
---|
58 | merging of a collection. The program outputs (on
|
---|
59 | .IR stdout )
|
---|
60 | the text of the collection.
|
---|
61 | .I Documents
|
---|
62 | within the collection are separated by ctrl-B's (ASCII code 2).
|
---|
63 | .TP
|
---|
64 | .BR \-cleanup " and " \-c
|
---|
65 | The program is called once with this flag at the completion of
|
---|
66 | merging a collection.
|
---|
67 | .SH ENVIRONMENT
|
---|
68 | .TP "\w'\fBMGDATA\fP'u+2n"
|
---|
69 | .SB MGDATA
|
---|
70 | If this environment variable exists, then its value is used as the
|
---|
71 | default directory where the
|
---|
72 | .BR mg (1)
|
---|
73 | collection files are. If this variable does not exist, then the
|
---|
74 | directory \*(lq\fB.\fP\*(rq is used by default. The command line
|
---|
75 | option
|
---|
76 | .BI \-d " directory"
|
---|
77 | overrides the directory in
|
---|
78 | .BR MGDATA .
|
---|
79 | .SH "SEE ALSO"
|
---|
80 | .na
|
---|
81 | .BR mg (1),
|
---|
82 | .BR mg_get (1),
|
---|
83 | .BR mgbuild (1),
|
---|
84 | .BR mgmerge (1),
|
---|
85 | .BR mg_text_merge (1),
|
---|
86 | .BR mg_invf_merge (1).
|
---|