~pkgcrosswire/sword/nroff-manpages

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
.\" addld man page
.\" Copyright (C) 2009 Jonathan Marsden
.\" Version 0.1
.TH ADDLD 1 "05 April 2009" "addld 1.0" "SWORD Project commands"
.SH NAME
addld \- Lexicon and Dictionary module creation tool for the SWORD Project
.SH SYNOPSIS
.\" for synopsis format see man man
\fBaddld \-\fR[\fBz\fR|\fB4\fR]\fBa \fIdictfile key\fR [\fIinputfile\fR]

\fBaddld \-\fR[\fBz\fR|\fB4\fR]\fBd \fIdictfile key\fR

\fBaddld \-\fR[\fBz\fR|\fB4\fR]\fBl \fIkey1 key2\fR

\fBaddld \-\fR[\fBz\fR|\fB4\fR]\fBc \fIdictfile\fR
.SH DESCRIPTION
.I addld
is a command line utility to create and manipulate Lexicon and
Dictionary SWORD modules. It can add, delete and link keys
within such a module.  It can also create new (empty) lexicon
or dictionary modules.
.SH OPTIONS
.TP
\fB\-\fR[\fBz\fR|\fB4\fR]\fBa \fIdictfile key\fR [\fIinputfile\fR]
Adds an entry with a key \fIkey\fR to the lexicon or dictionary named
\fIdictname\fR.  If supplied, \fIinputfile\fR is the path to a text
file containing the entry for this key.  If no \fIinputfile\fR is 
specified, the default is to read standard input for the entry.
.TP
\fB\-\fR[\fBz\fR|\fB4\fR]\fBd \fIdictfile key\fR
Deletes the entry with the given \fIkey\fR from the lexicon or 
dictionary named \fIdictfile\fR.
.TP
\fB\-\fR[\fBz\fR|\fB4\fR]\fBl \fIkey1 key2\fR
Links a new key \fIkey2\fR to an existing key \fIkey1\fR
in the lexicon or dictionary named \fIdictfile\fR.
.TP
\fB\-\fR[\fBz\fR|\fB4\fR]\fBc \fIdictfile\fR
Creates a new lexicon or dictionary module named \fIdictfile\fR.
.TP
.B \-z
Specifies a compressed zLD key format.  If supplied, must be 
immediately before an \fBa\fR, \fBc\fR, \fBd\fR, or \fBl\fR option.
The default key format is a two-byte key.
.TP
.B \-4
Specifies a four-byte key format.  If supplied, must be 
immediately before an \fBa\fR, \fBc\fR, \fBd\fR, or \fBl\fR option.
The default key format is a two-byte key.
.SH AUTHOR
\fBaddld\fR was written by the CrossWire Bible Society.
This manual page was written by Jonathan Marsden <jmarsden@fastmail.fm>
for the Debian project but may be used by others.

Both the \fBaddld\fR program and this manual page are
released under the GNU General Public License, version 2 or later.