mirror of
https://https.git.savannah.gnu.org/git/findutils.git
synced 2026-01-26 15:39:06 +00:00
2be6812e01
Reported at: https://lists.gnu.org/r/bug-findutils/2025-03/msg00002.html Output from "mandoc -T lint find.1": (shortened list) 1 input text line longer than 80 bytes: Some of the conversi... 1 missing date, using "": TH 1 unterminated quoted argument -.-. Output from "test-nroff -mandoc -t -ww -z find.1": (shortened list) 1 Use macro '.B' for one argument or split argument. 1 Use macro '.I' for one argument or split argument. 1 .BR is for at least 2 arguments, got 1 1 .IR is for at least 2 arguments, got 1 -.-. Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-), if it is in front of a name for an option, is a symbol for standard input, is a single character used to indicate an option, or is in the NAME section (man-pages(7)). N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen (0x2010, groff \[u2010] or \[hy]) in the output. 73:until an expression argument comes (which also starts with a `-'). 74:Now, if a path argument would start with a `-', then 875:An exception to this is when using only a slash as \fIpattern\fR (`-name /'), 878:A warning is issued if you try to pass a pattern containing a - but not 879:consisting solely of one - slash, unless the environment variable 1095:The + and - prefixes signify greater than and less than, as usual; 1832:find / -name needle -print -quit 2252:.SS Safer `find -print0 | xargs -0` approach 2324:.SS Traversing the filesystem just once - for 2 different actions 2473:Pruning - omitting files and subdirectories 2590:.B $ find / -name needle -print -quit 2607:.B $ find . .. / /tmp /tmp/TRACE compile compile/64/tests/find -maxdepth 0 -printf '[%h][%f]\en' 2654:.B find -print0 2656:.B xargs -0 2743:find: possible unquoted pattern after predicate `-name'? -.-. Add a "\&" (or a comma (Oxford comma)) after "e.g." and "i.e.", or use English words (man-pages(7)). Abbreviation points should be marked as such and protected against being interpreted as an end of sentence, if they are not, and that independent of the current place on the line. 546:and e.g. from a pipe. 565:The processing of the starting points is otherwise as usual, e.g. -.-. Wrong distance (not two spaces) between sentences in the input file. Separate the sentences and subordinate clauses; each begins on a new line. See man-pages(7) ("Conventions for source file layout") and "info groff" ("Input Conventions"). The best procedure is to always start a new sentence on a new line, at least, if you are typing on a computer. Remember coding: Only one command ("sentence") on each (logical) line. E-mail: Easier to quote exactly the relevant lines. Generally: Easier to edit the sentence. Patches: Less unaffected text. Search for two adjacent words is easier, when they belong to the same line, and the same phrase. The amount of space between sentences in the output can then be controlled with the ".ss" request. Mark a final abbreviation point as such by suffixing it with "\&". Some sentences (etc.) do not begin on a new line. Split (sometimes) lines after a punctuation mark; before a conjunction. Lines with only one (or two) space(s) between sentences could be split, so latter sentences begin on a new line. Use sed -e '/^\./n' \ -e 's/\([[:alpha:]]\)\. */\1.\n/g' $1 to split lines after a sentence period. Check result with the difference between the formatted outputs. See also the attachment "general.bugs" [List of affected lines removed.] -.-. Split lines longer than 80 characters into two or more lines. Appropriate break points are the end of a sentence and a subordinate clause; after punctuation marks. Add "\:" to split the string for the output, "\<newline>" in the source. Line 1546, length 86 Some of the conversion specification characters might not be available on all systems, Line 2487, length 82 .B $ find . \-name .snapshot \-prune \-o \e( \e! \-name \(aq*~\(aq \-print0 \e) \e Line 2607, length 96 .B $ find . .. / /tmp /tmp/TRACE compile compile/64/tests/find -maxdepth 0 -printf '[%h][%f]\en' Line 2645, length 87 .I A Research UNIX Reader: Annotated Excerpts from the Programmerâs Manual, 1971-1986 -.-. Use \(en (en-dash) for a dash at the beginning (end) of a line, or between space characters, not a minus (\-) or a hyphen (-), except in the NAME section. find.1:2324:.SS Traversing the filesystem just once - for 2 different actions find.1:2473:Pruning - omitting files and subdirectories -.-. Remove reverse slash (\) in front of a period (.) that is to be printed as such, and can not come a control character in the first column of a line. Use "\&" to protect the period to avoid that. This is a sign, that the man page was transformed from another source file with a program, whose name is NOT mentioned in a comment. 2715:\.B \-perm +MODE 2717:\.B \-perm -.-. Split a punctuation mark from a single argument for a two-font macro 1048:.IR ./fubar3, -.-. Put a parenthetical sentence, phrase on a separate line, if not part of a code. See man-pages(7), item "semantic newline". [List of affected lines removed.] -.-. One space only after an end of sentence. find.1:339:no error message will be issued. This is the reason why such operation find.1:546:and e.g. from a pipe. find.1:960:find . \-path \(dq./sr*sc\(dq find.1:1797:find . \-path ./src/emacs \-prune \-o \-print find.1:1896:.B find . \-name afile \-o \-name bfile \-print find.1:2309:.B $ find . \-type f \-exec file \(aq{}\(aq \e; find.1:2384:.B $ find . \-perm 664 find.1:2399:.B $ find . \-perm \-664 find.1:2413:.B $ find . \-perm /222 find.1:2423:.B $ find . \-perm /220 find.1:2424:.B $ find . \-perm /u+w,g+w find.1:2425:.B $ find . \-perm /u=w,g=w find.1:2440:.B $ find . \-perm \-220 find.1:2441:.B $ find . \-perm \-g+w,u+w find.1:2452:.B $ find . \-perm \-444 \-perm /222 \e! \-perm /111 find.1:2453:.B $ find . \-perm \-a+r \-perm /a+w \e! \-perm /a+x find.1:2467:.RB ( "! \-perm /111" find.1:2469:.B ! \-perm /a+x find.1:2487:.B $ find . \-name .snapshot \-prune \-o \e( \e! \-name \(aq*~\(aq \-print0 \e) \e find.1:2607:.B $ find . .. / /tmp /tmp/TRACE compile compile/64/tests/find -maxdepth 0 -printf '[%h][%f]\en' find.1:2727:.B find . \-name afile \-o \-name bfile \-print find.1:2731:.BR "find . \-name afile \-o \e( \-name bfile \-a \-print \e)" . find.1:2741:.B $ find . \-name *.c \-print find.1:2754:.B find . \-name frcode.c locate.c word_io.c \-print find.1:2766:.B $ find . \-name \(aq*.c\(aq \-print find.1:2767:.B $ find . \-name \e*.c \-print -.-. Put a subordinate sentence (after a comma) on a new line. [List of affected lines removed.] -.-. Remove quotes when there is a printable but no space character between them and the quotes are not for emphasis (markup), for example as an argument to a macro. find.1:638:.IP "\-noleaf" find.1:1154:.IP "\-writable" find.1:1196:.IP "\-delete\fR" find.1:1802:.IP "\-quit" find.1:2233:.SH "EXAMPLES" find.1:2638:.SH "HISTORY" find.1:2659:.SH "COMPATIBILITY" find.1:2724:.SH "NON-BUGS" find.1:2770:.SH "BUGS" -.-. Section headings (.SH and .SS) do not need quoting their arguments. 1968:.SH "STANDARDS CONFORMANCE" 2120:.SH "ENVIRONMENT VARIABLES" 2233:.SH "EXAMPLES" 2638:.SH "HISTORY" 2659:.SH "COMPATIBILITY" 2724:.SH "NON-BUGS" 2770:.SH "BUGS" 2788:.SH "REPORTING BUGS" 2811:.SH "SEE ALSO" -.-. Space after an end of sentence. temp.table:25:\-exec ... + 4.2.12 POSIX -.-. Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z ": an.tmac:<stdin>:2: style: .TH missing third argument; consider document modification date in ISO 8601 format (YYYY-MM-DD) an.tmac:<stdin>:2: style: .TH missing fourth argument; consider package/project name and version (e.g., "groff 1.23.0") an.tmac:<stdin>:690: misuse, warning: .BR is for at least 2 arguments, got 1 Use macro '.B' for one argument or split argument. an.tmac:<stdin>:1048: misuse, warning: .IR is for at least 2 arguments, got 1 Use macro '.I' for one argument or split argument. -.-. Additionally: Change "1\ KB" to "1\ KiB" Change indent "4m" to "4n". "4m" is too wide in troff-mode. Inhibit hyphenation of "strftime" once (based on an A4 page size). Create a "space" between some tags and the its following text by adding " \&" to the tag. Decrease indent after a bullet in lists. Generally: Split (sometimes) lines after a punctuation mark; before a conjunction. * find/find.1: Change as described above.
This package contains the GNU find, xargs, and locate programs. find
and xargs comply with POSIX 1003.2. They also support a large number
of additional options, some borrowed from Unix and some unique to GNU.
See the file NEWS for a list of major changes in the current release.
See the file COPYING for copying conditions.
See the file INSTALL for compilation and installation instructions.
If there is no file INSTALL, you must be looking at the checked-out
source code instead of at an unpacked source tarball ("release"). In
that case, you should first please read and follow the instructions in
the file README-hacking. Those instructions explain how to generate
the auto-generated files needed to build findutils, and this includes
generating the INSTALL file.
To verify the GPG signature of the release, you will need the public
key of the findutils maintainer. You can download this from
ftp://ftp.gnu.org/gnu/gnu-keyring.gpg. Alternatively, you could query
a PGP keyserver, but you will need to use one that can cope with
subkeys containing photos. Many older key servers cannot do this. I
use subkeys.pgp.net. I think that one works. See also the
"Downloading" section of https://www.gnu.org/software/findutils/.
Special configure options:
DEFAULT_ARG_SIZE=<value>
If this environment variable is defined to a numeric expression
during configure, it determines the default argument size limits used
by xargs without -s, and by find, when spawning child processes.
Otherwise, the default is set at 128 kibibytes. If the system cannot
support the default limit, the system's limit will be used instead.
To gain speed, GNU find avoids statting files whenever possible.
It does this by:
1. Checking the number of links to directories and not statting files
that it knows aren't directories until it encounters a test or action
that needs the stat info.
2. Rearranging the command line, where possible, so that it can do
tests that don't require a stat before tests that do, in hopes that
the latter will be skipped because of a -o/-a conjunction. (But it
only does this where it will leave the output unchanged.)
The locate program and its helper programs are derived (heavily
modified) from James Woods' public domain fast-find code, which is
also distributed with the 4.3BSD find. Because POSIX.2 requires `find
foo' to have the same effect as `find foo -print', the fast-find
searching has been moved to a separate program, `locate'; the same
thing has been done in 4.4BSD. If you use locate, you should run the
included `updatedb' script from cron periodically (typically nightly).
The latest full release is available at
http://ftp.gnu.org/gnu/findutils.
The latest test release (if any) is available at
http://alpha.gnu.org/gnu/findutils
Discussion of the findutils package and ways to improve it takes place
on the "bug-findutils" mailing list, which you can join by sending
mail to bug-findutils-request@gnu.org. An archive of patches to the
bug-findutils mailing list is available at
https://lists.gnu.org/r/bug-findutils/.
Bug reports, suggested patches and enhancement requests for findutils
should be logged at https://savannah.gnu.org/bugs/?group=findutils.
Changes to the findutils code are sent to the findutils-patches
mailing list. To join, please send email to
findutils-patches@gnu.org. You are also welcome to send patches to
that list, but unless you are a list subscriber, you won't be able to
follow any resulting discussion. An archive of posts to the
findutils-patches mailing list is available at
https://lists.gnu.org/r/findutils-patches/.
See https://savannah.gnu.org/git/?group=findutils for instructions on
how to use git to access the findutils source code.
Mail suggestions and bug reports for these programs to
bug-findutils@gnu.org.
GNU Project notice
==================
GNU findutils is part of the GNU Operating System, developed by the GNU Project.
If you are the author of an awesome program and want to join us in writing
Free (libre) Software, please consider making it an official GNU program and
become a GNU Maintainer. Instructions on how to do this are here:
https://www.gnu.org/help/evaluation
Don't have a program to contribute? Look at all the other ways to help:
https://www.gnu.org/help/help.html
And to learn more about Free (libre) Software in general, please read and
share this page:
https://gnu.org/philosophy/free-sw.html
We are looking forward to hacking with you!
========================================================================
Copyright (C) 1996-2025 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the "GNU Free
Documentation License" file as part of this distribution.