1 e2b5610c 2022-04-11 op .\" Copyright (c) 2022 Omar Polo <op@openbsd.org>
 2 e2b5610c 2022-04-11 op .\"
 3 e2b5610c 2022-04-11 op .\" Permission to use, copy, modify, and distribute this software for any
 4 e2b5610c 2022-04-11 op .\" purpose with or without fee is hereby granted, provided that the above
 5 e2b5610c 2022-04-11 op .\" copyright notice and this permission notice appear in all copies.
 6 e2b5610c 2022-04-11 op .\"
 7 e2b5610c 2022-04-11 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 8 e2b5610c 2022-04-11 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 9 e2b5610c 2022-04-11 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 e2b5610c 2022-04-11 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 e2b5610c 2022-04-11 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 e2b5610c 2022-04-11 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 e2b5610c 2022-04-11 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 e2b5610c 2022-04-11 op .Dd April 11, 2022
15 e2b5610c 2022-04-11 op .Dt MKFTSIDX 1
16 e2b5610c 2022-04-11 op .Os
17 e2b5610c 2022-04-11 op .Sh NAME
18 e2b5610c 2022-04-11 op .Nm mkftsidx
19 e2b5610c 2022-04-11 op .Nd construct fts database
20 e2b5610c 2022-04-11 op .Sh SYNOPSIS
21 e2b5610c 2022-04-11 op .Nm
22 e2b5610c 2022-04-11 op .Bk -words
23 e2b5610c 2022-04-11 op .Op Fl o Ar dbpath
24 e2b5610c 2022-04-11 op .Op Fl m Ar p|w
25 e2b5610c 2022-04-11 op .Op Ar path
26 e2b5610c 2022-04-11 op .Ek
27 e2b5610c 2022-04-11 op .Sh DESCRIPTION
28 e2b5610c 2022-04-11 op .Nm
29 e2b5610c 2022-04-11 op is a program to create a fts database for
30 e2b5610c 2022-04-11 op .Xr ftsearch 1 .
31 e2b5610c 2022-04-11 op The arguments are as follows:
32 e2b5610c 2022-04-11 op .Bl -tag -width Ds
33 e2b5610c 2022-04-11 op .It Fl o Ar dbpath
34 e2b5610c 2022-04-11 op Path to the database file to create.
35 e2b5610c 2022-04-11 op .Pa db
36 e2b5610c 2022-04-11 op by default.
37 e2b5610c 2022-04-11 op .It Fl m Ar p|w
38 e2b5610c 2022-04-11 op Set the mode.
39 e2b5610c 2022-04-11 op If
40 e2b5610c 2022-04-11 op .Ar p
41 e2b5610c 2022-04-11 op .Pq the default
42 e2b5610c 2022-04-11 op then create a database with the
43 e2b5610c 2022-04-11 op .Ox
44 e2b5610c 2022-04-11 op ports tree data,
45 e2b5610c 2022-04-11 op otherwise creates a database from a Wikipedia dump.
46 e2b5610c 2022-04-11 op .It Ar path
47 e2b5610c 2022-04-11 op Path to the sources.
48 e2b5610c 2022-04-11 op When working in
49 e2b5610c 2022-04-11 op .Ar p
50 e2b5610c 2022-04-11 op mode, it's the optional path to the sqlports database.
51 e2b5610c 2022-04-11 op Otherwise, it's the mandatory path to the Wikipedia file dump.
52 e2b5610c 2022-04-11 op .El
53 e2b5610c 2022-04-11 op .Sh EXAMPLES
54 e2b5610c 2022-04-11 op To create a database with the
55 e2b5610c 2022-04-11 op .Ox
56 e2b5610c 2022-04-11 op ports tree content:
57 e2b5610c 2022-04-11 op .Bd -literal -offset indent
58 e2b5610c 2022-04-11 op $ mkftsidx
59 e2b5610c 2022-04-11 op .Ed
60 e2b5610c 2022-04-11 op .Pp
61 e2b5610c 2022-04-11 op To create a database from a Wikipedia dump to the
62 e2b5610c 2022-04-11 op .Pa db.wiki
63 e2b5610c 2022-04-11 op file:
64 e2b5610c 2022-04-11 op .Bd -literal -offset indent
65 e2b5610c 2022-04-11 op $ mkftsidx -o db.wiki -mw enwiki-latest-abstract1.xml
66 e2b5610c 2022-04-11 op .Ed
67 e2b5610c 2022-04-11 op .Sh SEE ALSO
68 e2b5610c 2022-04-11 op .Xr ftsearch 1
69 e2b5610c 2022-04-11 op .Sh AUTHORS
70 e2b5610c 2022-04-11 op .An -nosplit
71 e2b5610c 2022-04-11 op The
72 e2b5610c 2022-04-11 op .Nm
73 e2b5610c 2022-04-11 op program was written by
74 e2b5610c 2022-04-11 op .An Omar Polo Aq Mt op@omarpolo.com .