From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from krisdoz.my.domain (schwarze@localhost [127.0.0.1]) by krisdoz.my.domain (8.14.5/8.14.5) with ESMTP id s3IAUcxR006098 for ; Fri, 18 Apr 2014 06:30:38 -0400 (EDT) Received: (from schwarze@localhost) by krisdoz.my.domain (8.14.5/8.14.3/Submit) id s3IAUcXQ011507; Fri, 18 Apr 2014 06:30:38 -0400 (EDT) Date: Fri, 18 Apr 2014 06:30:38 -0400 (EDT) Message-Id: <201404181030.s3IAUcXQ011507@krisdoz.my.domain> X-Mailinglist: mdocml-source Reply-To: source@mdocml.bsd.lv MIME-Version: 1.0 From: schwarze@mdocml.bsd.lv To: source@mdocml.bsd.lv Subject: mdocml: Slowly, the dust begins to settle. X-Mailer: activitymail 1.26, http://search.cpan.org/dist/activitymail/ Content-Type: text/plain; charset=utf-8 Log Message: ----------- Slowly, the dust begins to settle. We are keeping the traditional name makewhatis(8). No content change. Modified Files: -------------- mdocml: Makefile apropos.1 man.cgi.7 Added Files: ----------- mdocml: makewhatis.8 Removed Files: ------------- mdocml: mandocdb.8 Revision Data ------------- --- mandocdb.8 +++ /dev/null @@ -1,217 +0,0 @@ -.\" $Id: mandocdb.8,v 1.25 2014/04/04 02:31:07 schwarze Exp $ -.\" -.\" Copyright (c) 2011, 2012 Kristaps Dzonsons -.\" Copyright (c) 2011, 2012 Ingo Schwarze -.\" -.\" Permission to use, copy, modify, and distribute this software for any -.\" purpose with or without fee is hereby granted, provided that the above -.\" copyright notice and this permission notice appear in all copies. -.\" -.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES -.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF -.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES -.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN -.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF -.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. -.\" -.Dd $Mdocdate: April 4 2014 $ -.Dt MANDOCDB 8 -.Os -.Sh NAME -.Nm mandocdb -.Nd index UNIX manuals -.Sh SYNOPSIS -.Nm -.Op Fl aDnpQ -.Op Fl T Cm utf8 -.Op Fl C Ar file -.Nm -.Op Fl aDnpQ -.Op Fl T Cm utf8 -.Ar dir ... -.Nm -.Op Fl DnpQ -.Op Fl T Cm utf8 -.Fl d Ar dir -.Op Ar -.Nm -.Op Fl Dnp -.Op Fl T Cm utf8 -.Fl u Ar dir -.Op Ar -.Nm -.Op Fl Q -.Fl t Ar -.Sh DESCRIPTION -The -.Nm -utility extracts keywords from -.Ux -manuals and indexes them in a database for fast retrieval by -.Xr apropos 1 , -.Xr whatis 1 , -and -.Xr man 1 Ns 's -.Fl k -option. -.Pp -By default, -.Nm -creates a database in each -.Ar dir -using the files -.Sm off -.Sy man Ar section Li / -.Op Ar arch Li / -.Ar title . section -.Sm on -and -.Sm off -.Sy cat Ar section Li / -.Op Ar arch Li / -.Ar title . Sy 0 -.Sm on -in that directory. -Existing databases are replaced. -If -.Ar dir -is not provided, -.Nm -uses the default paths stipulated by -.Xr manpath 1 , -or -.Xr man.conf 5 . -.Pp -The arguments are as follows: -.Bl -tag -width "-C file" -.It Fl a -Use all directories and files found below -.Ar dir ... . -.It Fl C Ar file -Specify an alternative configuration -.Ar file -in -.Xr man.conf 5 -format. -.It Fl D -Display all files added or removed to the index. -With a second -.Fl D , -also show all keyswords added for each file. -.It Fl d Ar dir -Merge (remove and re-add) -.Ar -to the database in -.Ar dir . -.It Fl n -Do not create or modify any database; scan and parse only, -and print manual page names and descriptions to standard output. -.It Fl p -Print warnings about potential problems with manual pages -to the standard error output. -.It Fl Q -Quickly build reduced-size databases -by reading only the NAME sections of manuals. -The resulting databases will usually contain names and descriptions only. -.It Fl T Cm utf8 -Use UTF-8 encoding instead of ASCII for strings stored in the databases. -.It Fl t Ar -Check the given -.Ar files -for potential problems. -Implies -.Fl a , -.Fl n , -and -.Fl p . -All diagnostic messages are printed to the standard output; -the standard error output is not used. -.It Fl u Ar dir -Remove -.Ar -from the database in -.Ar dir . -.El -.Pp -If fatal parse errors are encountered while parsing, the offending file -is printed to stderr, omitted from the index, and the parse continues -with the next input file. -.Sh FILES -.Bl -tag -width Ds -.It Pa mandoc.db -A database of manpages relative to the directory of the file. -This file is portable across architectures and systems, so long as the -manpage hierarchy it indexes does not change. -.It Pa /etc/man.conf -The default -.Xr man 1 -configuration file. -.El -.Sh EXIT STATUS -The -.Nm -utility exits with one of the following values: -.Pp -.Bl -tag -width Ds -compact -.It 0 -No errors occurred. -.It 5 -Invalid command line arguments were specified. -No input files have been read. -.It 6 -An operating system error occurred, for example memory exhaustion or an -error accessing input files. -Such errors cause -.Nm -to exit at once, possibly in the middle of parsing or formatting a file. -The output databases are corrupt and should be removed. -.El -.Sh SEE ALSO -.Xr apropos 1 , -.Xr man 1 , -.Xr whatis 1 , -.Xr man.conf 5 -.Sh HISTORY -A -.Nm makewhatis -utility first appeared in -.Bx 2 . -It was rewritten in -.Xr perl 1 -for -.Ox 2.7 -and in C for -.Ox 5.6 . -.Pp -The -.Ar dir -argument first appeared in -.Nx 1.0 ; -the options -.Fl dpt -in -.Ox 2.7 ; -the option -.Fl u -in -.Ox 3.4 ; -and the options -.Fl aCDnQT -in -.Ox 5.6 . -.Sh AUTHORS -.An -nosplit -.An Bill Joy -wrote the original -.Bx -.Nm makewhatis -in February 1979, -.An Marc Espie -started the Perl version in 2000, -and the current version of -.Nm -was written by -.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv -and -.An Ingo Schwarze Aq Mt schwarze@openbsd.org . --- /dev/null +++ makewhatis.8 @@ -0,0 +1,217 @@ +.\" $Id: makewhatis.8,v 1.1 2014/04/18 10:30:37 schwarze Exp $ +.\" +.\" Copyright (c) 2011, 2012 Kristaps Dzonsons +.\" Copyright (c) 2011, 2012 Ingo Schwarze +.\" +.\" Permission to use, copy, modify, and distribute this software for any +.\" purpose with or without fee is hereby granted, provided that the above +.\" copyright notice and this permission notice appear in all copies. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +.\" +.Dd $Mdocdate: April 18 2014 $ +.Dt MAKEWHATIS 8 +.Os +.Sh NAME +.Nm makewhatis +.Nd index UNIX manuals +.Sh SYNOPSIS +.Nm +.Op Fl aDnpQ +.Op Fl T Cm utf8 +.Op Fl C Ar file +.Nm +.Op Fl aDnpQ +.Op Fl T Cm utf8 +.Ar dir ... +.Nm +.Op Fl DnpQ +.Op Fl T Cm utf8 +.Fl d Ar dir +.Op Ar +.Nm +.Op Fl Dnp +.Op Fl T Cm utf8 +.Fl u Ar dir +.Op Ar +.Nm +.Op Fl Q +.Fl t Ar +.Sh DESCRIPTION +The +.Nm +utility extracts keywords from +.Ux +manuals and indexes them in a database for fast retrieval by +.Xr apropos 1 , +.Xr whatis 1 , +and +.Xr man 1 Ns 's +.Fl k +option. +.Pp +By default, +.Nm +creates a database in each +.Ar dir +using the files +.Sm off +.Sy man Ar section Li / +.Op Ar arch Li / +.Ar title . section +.Sm on +and +.Sm off +.Sy cat Ar section Li / +.Op Ar arch Li / +.Ar title . Sy 0 +.Sm on +in that directory. +Existing databases are replaced. +If +.Ar dir +is not provided, +.Nm +uses the default paths stipulated by +.Xr manpath 1 , +or +.Xr man.conf 5 . +.Pp +The arguments are as follows: +.Bl -tag -width "-C file" +.It Fl a +Use all directories and files found below +.Ar dir ... . +.It Fl C Ar file +Specify an alternative configuration +.Ar file +in +.Xr man.conf 5 +format. +.It Fl D +Display all files added or removed to the index. +With a second +.Fl D , +also show all keyswords added for each file. +.It Fl d Ar dir +Merge (remove and re-add) +.Ar +to the database in +.Ar dir . +.It Fl n +Do not create or modify any database; scan and parse only, +and print manual page names and descriptions to standard output. +.It Fl p +Print warnings about potential problems with manual pages +to the standard error output. +.It Fl Q +Quickly build reduced-size databases +by reading only the NAME sections of manuals. +The resulting databases will usually contain names and descriptions only. +.It Fl T Cm utf8 +Use UTF-8 encoding instead of ASCII for strings stored in the databases. +.It Fl t Ar +Check the given +.Ar files +for potential problems. +Implies +.Fl a , +.Fl n , +and +.Fl p . +All diagnostic messages are printed to the standard output; +the standard error output is not used. +.It Fl u Ar dir +Remove +.Ar +from the database in +.Ar dir . +.El +.Pp +If fatal parse errors are encountered while parsing, the offending file +is printed to stderr, omitted from the index, and the parse continues +with the next input file. +.Sh FILES +.Bl -tag -width Ds +.It Pa mandoc.db +A database of manpages relative to the directory of the file. +This file is portable across architectures and systems, so long as the +manpage hierarchy it indexes does not change. +.It Pa /etc/man.conf +The default +.Xr man 1 +configuration file. +.El +.Sh EXIT STATUS +The +.Nm +utility exits with one of the following values: +.Pp +.Bl -tag -width Ds -compact +.It 0 +No errors occurred. +.It 5 +Invalid command line arguments were specified. +No input files have been read. +.It 6 +An operating system error occurred, for example memory exhaustion or an +error accessing input files. +Such errors cause +.Nm +to exit at once, possibly in the middle of parsing or formatting a file. +The output databases are corrupt and should be removed. +.El +.Sh SEE ALSO +.Xr apropos 1 , +.Xr man 1 , +.Xr whatis 1 , +.Xr man.conf 5 +.Sh HISTORY +A +.Nm +utility first appeared in +.Bx 2 . +It was rewritten in +.Xr perl 1 +for +.Ox 2.7 +and in C for +.Ox 5.6 . +.Pp +The +.Ar dir +argument first appeared in +.Nx 1.0 ; +the options +.Fl dpt +in +.Ox 2.7 ; +the option +.Fl u +in +.Ox 3.4 ; +and the options +.Fl aCDnQT +in +.Ox 5.6 . +.Sh AUTHORS +.An -nosplit +.An Bill Joy +wrote the original +.Bx +.Nm +in February 1979, +.An Marc Espie +started the Perl version in 2000, +and the current version of +.Nm +was written by +.An Kristaps Dzonsons Aq Mt kristaps@bsd.lv +and +.An Ingo Schwarze Aq Mt schwarze@openbsd.org . Index: man.cgi.7 =================================================================== RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/man.cgi.7,v retrieving revision 1.12 retrieving revision 1.13 diff -Lman.cgi.7 -Lman.cgi.7 -u -p -r1.12 -r1.13 --- man.cgi.7 +++ man.cgi.7 @@ -11,7 +11,7 @@ The .Nm script queries and displays manual pages. It interfaces with -.Xr mandocdb 8 +.Xr makewhatis 8 databases cached with .Xr catman 8 . .Pp @@ -109,7 +109,7 @@ script by Wolfram Schneider. However, the results may not be quite the same. .Sh SEE ALSO .Xr catman 8 , -.Xr mandocdb 8 +.Xr makewhatis 8 .Sh AUTHORS The .Nm Index: apropos.1 =================================================================== RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/apropos.1,v retrieving revision 1.27 retrieving revision 1.28 diff -Lapropos.1 -Lapropos.1 -u -p -r1.27 -r1.28 --- apropos.1 +++ apropos.1 @@ -37,7 +37,7 @@ The and .Nm whatis utilities query manual page databases generated by -.Xr mandocdb 8 , +.Xr makewhatis 8 , evaluating .Ar expression for each file in each database. @@ -47,7 +47,7 @@ of all matching manuals. By default, .Nm searches for -.Xr mandocdb 8 +.Xr makewhatis 8 databases in the default paths stipulated by .Xr man 1 and uses case-insensitive substring matching @@ -70,13 +70,13 @@ format. .It Fl M Ar path Use the colon-separated path instead of the default list of paths searched for -.Xr mandocdb 8 +.Xr makewhatis 8 databases. Invalid paths, or paths without manual databases, are ignored. .It Fl m Ar path Prepend the colon-separated paths to the list of paths searched for -.Xr mandocdb 8 +.Xr makewhatis 8 databases. Invalid paths, or paths without manual databases, are ignored. .It Fl O Ar outkey @@ -196,7 +196,7 @@ If an architecture is specified in the o Queries evaluate over a subset of .Xr mdoc 7 macros indexed by -.Xr mandocdb 8 . +.Xr makewhatis 8 . In addition to the macro keys listed below, the special key .Cm any may be used to match any available macro key. @@ -293,7 +293,7 @@ standard search path. .Bl -tag -width "/etc/man.conf" -compact .It Pa mandoc.db name of the -.Xr mandocdb 8 +.Xr makewhatis 8 keyword database .It Pa /etc/man.conf default @@ -347,7 +347,7 @@ The following two invocations are equiva .Sh SEE ALSO .Xr man 1 , .Xr re_format 7 , -.Xr mandocdb 8 +.Xr makewhatis 8 .Sh HISTORY An .Nm Index: Makefile =================================================================== RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/Makefile,v retrieving revision 1.415 retrieving revision 1.416 diff -LMakefile -LMakefile -u -p -r1.415 -r1.416 --- Makefile +++ Makefile @@ -22,7 +22,7 @@ CFLAGS += -DUSE_WCHAR # If your system has manpath(1), uncomment this. This is most any # system that's not OpenBSD or NetBSD. If uncommented, manpage(1) and -# mandocdb(8) will use manpath(1) to get the MANPATH variable. +# makewhatis(8) will use manpath(1) to get the MANPATH variable. #CFLAGS += -DUSE_MANPATH # If your system does not support static binaries, comment this, @@ -52,7 +52,7 @@ INSTALL_MAN = $(INSTALL_DATA) # If you want to build without database support, for example to avoid # the dependency on SQLite3, comment the following two lines. DBLIB = -L/usr/local/lib -lsqlite3 -DBBIN = mandocdb manpage apropos +DBBIN = makewhatis manpage apropos # === END OF USER SETTINGS ============================================= @@ -111,6 +111,7 @@ SRCS = Makefile \ libroff.h \ main.c \ main.h \ + makewhatis.8 \ man.7 \ man.c \ man-cgi.css \ @@ -128,7 +129,6 @@ SRCS = Makefile \ mandoc_aux.c \ mandoc_aux.h \ mandoc_char.7 \ - mandocdb.8 \ mandocdb.c \ manpage.c \ manpath.c \ @@ -259,8 +259,8 @@ MANDOC_OBJS = $(MANDOC_HTML_OBJS) \ tree.o $(MANDOC_OBJS): main.h mandoc.h mandoc_aux.h mdoc.h man.h config.h out.h -MANDOCDB_OBJS = mandocdb.o mansearch_const.o manpath.o -$(MANDOCDB_OBJS): mansearch.h mandoc.h mandoc_aux.h \ +MAKEWHATIS_OBJS = mandocdb.o mansearch_const.o manpath.o +$(MAKEWHATIS_OBJS): mansearch.h mandoc.h mandoc_aux.h \ mdoc.h man.h config.h manpath.h PRECONV_OBJS = preconv.o @@ -289,7 +289,7 @@ WWW_MANS = apropos.1.html \ mdoc.7.html \ roff.7.html \ tbl.7.html \ - mandocdb.8.html \ + makewhatis.8.html \ man.h.html \ mandoc.h.html \ manpath.h.html \ @@ -304,7 +304,7 @@ WWW_OBJS = mdocml.tar.gz \ clean: rm -f libmandoc.a $(LIBMANDOC_OBJS) rm -f apropos $(APROPOS_OBJS) - rm -f mandocdb $(MANDOCDB_OBJS) + rm -f makewhatis $(MAKEWHATIS_OBJS) rm -f preconv $(PRECONV_OBJS) rm -f manpage $(MANPAGE_OBJS) rm -f demandoc $(DEMANDOC_OBJS) @@ -353,8 +353,8 @@ libmandoc.a: $(COMPAT_OBJS) $(LIBMANDOC_ mandoc: $(MANDOC_OBJS) libmandoc.a $(CC) $(LDFLAGS) -o $@ $(MANDOC_OBJS) libmandoc.a -mandocdb: $(MANDOCDB_OBJS) libmandoc.a - $(CC) $(LDFLAGS) -o $@ $(MANDOCDB_OBJS) libmandoc.a $(DBLIB) +makewhatis: $(MAKEWHATIS_OBJS) libmandoc.a + $(CC) $(LDFLAGS) -o $@ $(MAKEWHATIS_OBJS) libmandoc.a $(DBLIB) preconv: $(PRECONV_OBJS) $(CC) $(LDFLAGS) -o $@ $(PRECONV_OBJS) -- To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv