[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: src/utils/indxbib/*: Improve the license information.
From: |
Bernd Warken |
Subject: |
[groff] 01/01: src/utils/indxbib/*: Improve the license information. |
Date: |
Thu, 18 Sep 2014 02:14:03 +0000 |
bwarken pushed a commit to branch master
in repository groff.
commit 4fc8d7d4a58c6aebc9d9e401cf4f69c072cc5004
Author: Bernd Warken <address@hidden>
Date: Thu Sep 18 04:13:56 2014 +0200
src/utils/indxbib/*: Improve the license information.
---
ChangeLog | 4 ++
src/utils/indxbib/Makefile.sub | 5 +--
src/utils/indxbib/indxbib.cpp | 3 +-
src/utils/indxbib/indxbib.man | 84 ++++++++++++++++++++++++++++++++++++----
src/utils/indxbib/signal.c | 3 +-
5 files changed, 83 insertions(+), 16 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 6884acf..b89d7df 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,9 @@
2014-09-18 Bernd Warken <address@hidden>
+ * src/utils/indxbib/*: Improve the license information.
+
+2014-09-18 Bernd Warken <address@hidden>
+
* src/utils/hpftodit/*: Improve the license information.
2014-09-18 Bernd Warken <address@hidden>
diff --git a/src/utils/indxbib/Makefile.sub b/src/utils/indxbib/Makefile.sub
index 8bfd50b..e755d58 100644
--- a/src/utils/indxbib/Makefile.sub
+++ b/src/utils/indxbib/Makefile.sub
@@ -2,10 +2,7 @@
#
# File position: <groff-source>/src/utils/indxbib/Makefile.sub
#
-# Copyright (C) 2014
-# Free Software Foundation, Inc.
-#
-# Last update: 2 Sep 2014
+# Copyright (C) 2014 Free Software Foundation, Inc.
#
# This file is part of `font utf8' which is part of `groff'.
#
diff --git a/src/utils/indxbib/indxbib.cpp b/src/utils/indxbib/indxbib.cpp
index 8f9c423..ee568d8 100644
--- a/src/utils/indxbib/indxbib.cpp
+++ b/src/utils/indxbib/indxbib.cpp
@@ -1,6 +1,5 @@
// -*- C++ -*-
-/* Copyright (C) 1989-1992, 2000, 2001, 2002, 2003, 2004, 2009
- Free Software Foundation, Inc.
+/* Copyright (C) 1989-2014 Free Software Foundation, Inc.
Written by James Clark (address@hidden)
This file is part of groff.
diff --git a/src/utils/indxbib/indxbib.man b/src/utils/indxbib/indxbib.man
index 9a9fc8a..262e432 100644
--- a/src/utils/indxbib/indxbib.man
+++ b/src/utils/indxbib/indxbib.man
@@ -1,5 +1,10 @@
-.ig
-Copyright (C) 1989-2000, 2001, 2009 Free Software Foundation, Inc.
+.TH @address@hidden @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
+.SH NAME
address@hidden@indxbib \- make inverted index for bibliographic databases
+.
+.
+.de co
+Copyright (C) 1989-2014 Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
@@ -16,10 +21,11 @@ versions, except that this permission notice may be
included in
translations approved by the Free Software Foundation instead of in
the original English.
..
-.TH @address@hidden @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
-.SH NAME
address@hidden@indxbib \- make inverted index for bibliographic databases
+.
+.\" --------------------------------------------------------------------
.SH SYNOPSIS
+.\" --------------------------------------------------------------------
+.
.nr a \n(.j
.ad l
.nr i \n(.i
@@ -43,7 +49,12 @@ the original English.
.OP \-t n
.RI [\ filename \|.\|.\|.\ ]
.ad \na
+.
+.
+.\" --------------------------------------------------------------------
.SH DESCRIPTION
+.\" --------------------------------------------------------------------
+.
.B @address@hidden
makes an inverted index for the bibliographic databases in
.IR filename \|.\|.\|.
@@ -52,23 +63,31 @@ for use with
.BR @address@hidden (@MAN1EXT@),
and
.BR lkbib (@MAN1EXT@).
+.
The index will be named
.IB filename @address@hidden;
-the index is written to a temporary file which is then renamed to this.
+the index is written to a temporary file which is then renamed to
+this.
+.
If no filenames are given on the command line because the
.B \-f
option has been used, and no
.B \-o
option is given, the index will be named
.BR @DEFAULT_INDEX_NAME@@INDEX_SUFFIX@ .
+.
+.
.LP
Bibliographic databases are divided into records by blank lines.
Within a record, each fields starts with a
.B %
character at the beginning of a line.
+.
Fields have a one letter name which follows the
.B %
character.
+.
+.
.LP
The values set by the
.BR \-c ,
@@ -81,33 +100,44 @@ when the index is searched, keys will be discarded and
truncated in a
manner appropriate to these options;
the original keys will be used for verifying that any record
found using the index actually contains the keys.
+.
This means that a user of an index need not know whether these
options were used in the creation of the index,
provided that not all the keys to be searched for
would have been discarded during indexing
and that the user supplies at least the part of each key
that would have remained after being truncated during indexing.
+.
The value set by the
.B \-i
option is also stored in the index
and will be used in verifying records found using the index.
+.
+.
+.\" --------------------------------------------------------------------
.SH OPTIONS
-.PP
+.\" --------------------------------------------------------------------
+.
It is possible to have whitespace between a command line option and its
parameter.
+.
.TP
.B \-v
Print the version number.
+.
.TP
.B \-w
Index whole files.
+.
Each file is a separate record.
+.
.TP
.BI \-c file
Read the list of common words from
.I file
instead of
.BR @COMMON_WORDS_FILE@ .
+.
.TP
.BI \-d dir
Use
@@ -115,14 +145,17 @@ Use
as the pathname of the current working directory to store in the index,
instead of the path printed by
.BR pwd (1).
+.
Usually
.I dir
will be a symbolic link that points to the directory printed by
.BR pwd (1).
+.
.TP
.BI \-f file
Read the files to be indexed from
.IR file .
+.
If
.I file
is
@@ -131,19 +164,23 @@ files will be read from the standard input.
The
.B \-f
option can be given at most once.
+.
.TP
.BI \-i string
-Don't index the contents of fields whose names are in
+Don\[aq]t index the contents of fields whose names are in
.IR string .
+.
Initially
.I string
is
.BR XYZ .
+.
.TP
.BI \-h n
Use the first prime greater than or equal to
.I n
for the size of the hash table.
+.
Larger values of
.I n
will usually make searching faster,
@@ -151,61 +188,92 @@ but will make the index larger
and
.B @address@hidden
use more memory.
+.
Initially
.I n
is 997.
+.
.TP
.BI \-k n
Use at most
.I n
keys per input record.
+.
Initially
.I n
is 100.
+.
.TP
.BI \-l n
Discard keys that are shorter than
.IR n .
+.
Initially
.I n
is 3.
+.
.TP
.BI \-n n
Discard the
.I n
most common words.
+.
Initially
.I n
is 100.
+.
.TP
.BI \-o basename
The index should be named
.IB basename @address@hidden
+.
.TP
.BI \-t n
Truncate keys to
.IR n .
+.
Initially
.I n
is 6.
+.
+.
+.\" --------------------------------------------------------------------
.SH FILES
+.\" --------------------------------------------------------------------
+.
.TP \w'\fBindxbib\fIXXXXXX'u+2n
.IB filename @INDEX_SUFFIX@
Index.
+.
.TP
.B @DEFAULT_INDEX_NAME@@INDEX_SUFFIX@
Default index name.
+.
.TP
.B @COMMON_WORDS_FILE@
List of common words.
+.
.TP
.BI indxbib XXXXXX
Temporary file.
+.
+.
+.\" --------------------------------------------------------------------
.SH "SEE ALSO"
+.\" --------------------------------------------------------------------
+.
.BR @address@hidden (@MAN1EXT@),
.BR lkbib (@MAN1EXT@),
.BR @address@hidden (@MAN1EXT@)
.
+.
+.\" --------------------------------------------------------------------
+.SH COPYING
+.\" --------------------------------------------------------------------
+.
+.co
+.
+.
.\" Local Variables:
.\" mode: nroff
.\" End:
diff --git a/src/utils/indxbib/signal.c b/src/utils/indxbib/signal.c
index d1c4c2b..4ff6fa9 100644
--- a/src/utils/indxbib/signal.c
+++ b/src/utils/indxbib/signal.c
@@ -1,5 +1,4 @@
-/* Copyright (C) 1992, 2001, 2003, 2004, 2009
- Free Software Foundation, Inc.
+/* Copyright (C) 1992-2014 Free Software Foundation, Inc.
Written by James Clark (address@hidden)
This file is part of groff.
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: src/utils/indxbib/*: Improve the license information.,
Bernd Warken <=