From ab3bb081baa74a6d23ab7728a010a51bd1585d5a Mon Sep 17 00:00:00 2001 From: Bernhard Voelker Date: Sun, 27 Dec 2020 23:14:01 +0100 Subject: doc: harmonize the end of the man pages The "BUGS" section also documented how to report bugs. This is better done in a separate "REPORTING BUGS" section. Add this section where missing. In it, redirect the user to the "How to get help" section ("#get-help") of the GNU findutils online page; also mention where to report translation issues. Bring the sections "SEE ALSO" and "COPYRIGHT" into the correct order, which is: "REPORTING BUGS", "COPYRIGHT" and finally "SEE ALSO". See 'man-pages(7)'. The "SEE ALSO" section now refers to both the corresponding node in the online HTML version of the Texinfo manual and lists the 'info' command. Sort the entries referring to other man pages: first by their manual section numbers, then alphabetically. While at it, add an empty line (directive '.') before all '.SH' section headers. * find/find.1: Do the above. * locate/locate.1: Likewise. * locate/locatedb.5: Likewise. * locate/updatedb.1: Likewise. * xargs/xargs.1: Likewise. --- locate/locate.1 | 73 +++++++++++++++++++++++++++++-------------------------- locate/locatedb.5 | 47 +++++++++++++++++++++++------------ locate/updatedb.1 | 67 +++++++++++++++++++++++++++----------------------- 3 files changed, 108 insertions(+), 79 deletions(-) (limited to 'locate') diff --git a/locate/locate.1 b/locate/locate.1 index afb45166..e580a009 100644 --- a/locate/locate.1 +++ b/locate/locate.1 @@ -1,6 +1,7 @@ .TH LOCATE 1 \" -*- nroff -*- .SH NAME locate \- list files in databases that match a pattern +. .SH SYNOPSIS .B locate [\-d path | \-\-database=path] @@ -61,7 +62,7 @@ escaped in the same way as for the \-print action of the .B find command. If the output is not going to a terminal, file names are printed exactly as-is. - +. .SH OPTIONS .TP .I "\-0, \-\-null" @@ -213,22 +214,7 @@ Colon-separated list of databases to search. If the value has a leading or trailing colon, or has two colons in a row, you may get results that vary between different versions of .BR locate . - -.SH "SEE ALSO" -\fBfind\fP(1), \fBlocatedb\fP(5), \fBupdatedb\fP(1), \fBxargs\fP(1), -\fBglob\fP(3) - -The full documentation for -.B locate -is maintained as a Texinfo manual. If the -.B info -and -.B locate -programs are properly installed at your site, the command -.B info locate -should give you access to the complete manual. - - +. .SH "HISTORY" The .B locate @@ -270,14 +256,7 @@ LL. 4.0 | Introduced the LOCATE02 database format 3.7 | Locate can search multiple databases .TE - -.SH COPYRIGHT -Copyright \(co 1994-2020 Free Software Foundation, Inc. -License GPLv3+: GNU GPL version 3 or later . -.br -This is free software: you are free to change and redistribute it. -There is NO WARRANTY, to the extent permitted by law. - +. .SH "BUGS" The locate database correctly handles filenames containing newlines, but only if the system's sort command has a working @@ -287,12 +266,38 @@ option. If you suspect that may need to return filenames containing newlines, consider using its .I \-\-null option. -.P -The best way to report a bug is to use the form at -https://savannah.gnu.org/bugs/?group=findutils. -The reason for this is that you will then be able to track progress in -fixing the problem. Other comments about \fBlocate\fP(1) and about -the findutils package in general can be sent to the -.I bug-findutils -mailing list. To join the list, send email to -.IR bug-findutils-request@gnu.org . +. +.SH "REPORTING BUGS" +GNU findutils online help: +.br +Report any translation bugs to +.PP +Report any other issue via the form at the GNU Savannah bug tracker: +.RS + +.RE +General topics about the GNU findutils package are discussed at the +.I bug\-findutils +mailing list: +.RS + +.RE +. +.SH COPYRIGHT +Copyright \(co 1994-2020 Free Software Foundation, Inc. +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. +. +.SH "SEE ALSO" +.BR find (1), +.BR updatedb (1), +.BR xargs (1), +.BR glob (3), +.BR locatedb (5) +.PP +Full documentation +.br +or available locally via: +.B info locate diff --git a/locate/locatedb.5 b/locate/locatedb.5 index cfd3f1d4..51972b74 100644 --- a/locate/locatedb.5 +++ b/locate/locatedb.5 @@ -1,6 +1,7 @@ .TH LOCATEDB 5 \" -*- nroff -*- .SH NAME locatedb \- front-compressed file name database +. .SH DESCRIPTION This manual page documents the format of file name databases for the GNU version of @@ -16,7 +17,7 @@ databases are updated, and the directories for which they contain entries. Normally, file name databases are updated by running the \fBupdatedb\fP program periodically, typically nightly; see \fBupdatedb\fP(1). - +. .SH GNU LOCATE02 database format This is the default format of databases produced by .BR updatedb . @@ -58,6 +59,7 @@ in any particular order. To obtain sorted results, pipe the output of .B locate through .BR "sort -f" . +. .SH slocate database format The .B slocate @@ -80,7 +82,7 @@ the differential count for the first item is assumed to be zero. .P Starting with the second entry (if any) in the database, data is interpreted as for the GNU LOCATE02 format. - +. .SH Old Locate Database format There is also an old database format, used by Unix .B locate @@ -110,6 +112,7 @@ than the new format, but makes them not 8-bit clean. Any byte in a file name that is in the ranges used for the special codes is replaced in the database by a question mark, which not coincidentally is the shell wildcard to match a single character. +. .SH EXAMPLE .nf @@ -138,23 +141,37 @@ and count bytes made printable: (6 = 14 - 8, and -9 = 5 - 14) .fi - +. +.SH "REPORTING BUGS" +GNU findutils online help: +.br +Report any translation bugs to +.PP +Report any other issue via the form at the GNU Savannah bug tracker: +.RS + +.RE +General topics about the GNU findutils package are discussed at the +.I bug\-findutils +mailing list: +.RS + +.RE +. .SH COPYRIGHT Copyright \(co 1994-2020 Free Software Foundation, Inc. License GPLv3+: GNU GPL version 3 or later . .br This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. - +. .SH "SEE ALSO" -\fBfind\fP(1), \fBlocate\fP(1), \fBlocatedb\fP(5), \fBxargs\fP(1), -\fBFinding Files\fP (on-line in Info, or printed) -.SH "BUGS" -The best way to report a bug is to use the form at -https://savannah.gnu.org/bugs/?group=findutils. -The reason for this is that you will then be able to track progress in -fixing the problem. Other comments about \fBlocate\fP(1) and about -the findutils package in general can be sent to the -.I bug-findutils -mailing list. To join the list, send email to -.IR bug-findutils-request@gnu.org . +.BR find (1), +.BR locate (1), +.BR xargs (1), +.BR locatedb (5) +.PP +Full documentation +.br +or available locally via: +.B info locatedb diff --git a/locate/updatedb.1 b/locate/updatedb.1 index dc2c4911..fee8a27a 100644 --- a/locate/updatedb.1 +++ b/locate/updatedb.1 @@ -3,6 +3,7 @@ updatedb \- update a file name database .SH SYNOPSIS .B updatedb [\fIoptions\fP] +. .SH DESCRIPTION This manual page documents the GNU version of @@ -36,7 +37,7 @@ can read both the old and .B LOCATE02 database formats, though support for the old pre-4.0 database format will be removed shortly. - +. .SH OPTIONS .TP .B \-\-findoptions='\fI\-option1 \-option2...\fP' @@ -108,26 +109,7 @@ and exit. Print a summary of the options to .B updatedb and exit. -.SH "SEE ALSO" -\fBfind\fP(1), \fBlocate\fP(1), \fBlocatedb\fP(5), \fBxargs\fP(1) - -The full documentation for -.B updatedb -is maintained as a Texinfo manual. If the -.B info -and -.B updatedb -programs are properly installed at your site, the command -.B info updatedb -should give you access to the complete manual. - -.SH COPYRIGHT -Copyright \(co 1994-2020 Free Software Foundation, Inc. -License GPLv3+: GNU GPL version 3 or later . -.br -This is free software: you are free to change and redistribute it. -There is NO WARRANTY, to the extent permitted by law. - +. .SH "BUGS" The .B updatedb @@ -139,12 +121,37 @@ option. If you suspect that may need to return filenames containing newlines, consider using its .I \-\-null option. -.P -The best way to report a bug is to use the form at -https://savannah.gnu.org/bugs/?group=findutils. -The reason for this is that you will then be able to track progress in -fixing the problem. Other comments about \fBupdatedb\fP(1) and about -the findutils package in general can be sent to the -.I bug-findutils -mailing list. To join the list, send email to -.IR bug-findutils-request@gnu.org . +. +.SH "REPORTING BUGS" +GNU findutils online help: +.br +Report any translation bugs to +.PP +Report any other issue via the form at the GNU Savannah bug tracker: +.RS + +.RE +General topics about the GNU findutils package are discussed at the +.I bug\-findutils +mailing list: +.RS + +.RE +. +.SH COPYRIGHT +Copyright \(co 1994-2020 Free Software Foundation, Inc. +License GPLv3+: GNU GPL version 3 or later . +.br +This is free software: you are free to change and redistribute it. +There is NO WARRANTY, to the extent permitted by law. +. +.SH "SEE ALSO" +.BR find (1), +.BR locate (1), +.BR xargs (1), +.BR locatedb (5) +.PP +Full documentation +.br +or available locally via: +.B info updatedb -- cgit v1.2.1