Various pages: Use the 'logical' quoting method
PATCH 1/1 Various pages: Use the 'logical' quoting method
This fix places periods after the closing quotes.
This is preferred practice in Great Britain,
and normative in various European languages.
See "Hart's Rules",
and the "Oxford Dictionary for Writers and Editors".
Found using:
$ find man? -type f \ |grep -n '^[^.].*[^."]\."' \ |less;
--- man2/access.2 | 2 +- man2/mknod.2 | 2 +- man2/mmap.2 | 2 +- man2/shmget.2 | 2 +- man2/vfork.2 | 2 +- man3/cfree.3 | 2 +- man3/ctime.3 | 2 +- man3/lseek64.3 | 2 +- man3/rcmd.3 | 2 +- man5/passwd.5 | 2 +- man7/man.7 | 2 +- man7/pthreads.7 | 2 +- man7/uri.7 | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-)
man2/access.2 +1 -1
@@ -346,7 +346,7 @@ Only access bits are checked, not the file type or contents. Therefore, if a directory is found to be writable, it probably means that files can be created in the directory, and not that the directory can be written as a file. -Similarly, a DOS file may be found to be "executable," but the +Similarly, a DOS file may be found to be "executable", but the .BR execve (2) call will still fail. .PP
man2/mknod.2 +1 -1
@@ -265,7 +265,7 @@ or .I dev is not 0, the behavior of .BR mknod () -is unspecified." +is unspecified.". However, nowadays one should never use .BR mknod () for this purpose; one should use
man2/mmap.2 +1 -1
@@ -310,7 +310,7 @@ at which point touching the "guard" page will result in a signal. .TP .BR MAP_HUGETLB " (since Linux 2.6.32)" -Allocate the mapping using "huge pages." +Allocate the mapping using "huge pages". See the Linux kernel source file .I Documentation/admin\-guide/mm/hugetlbpage.rst for further information, as well as NOTES, below.
man2/shmget.2 +1 -1
@@ -117,7 +117,7 @@ to ensure that this call creates the segment. If the segment already exists, the call fails. .TP .BR SHM_HUGETLB " (since Linux 2.6)" -Allocate the segment using "huge pages." +Allocate the segment using "huge pages". See the Linux kernel source file .I Documentation/admin\-guide/mm/hugetlbpage.rst for further information.
man2/vfork.2 +1 -1
@@ -311,7 +311,7 @@ or .B SIGTTIN signals; rather, output or .IR ioctl s -are allowed and input attempts result in an end-of-file indication." +are allowed and input attempts result in an end-of-file indication.". .\" .\" As far as I can tell, the following is not true in 2.6.19: .\" Currently (Linux 2.3.25),
man3/cfree.3 +1 -1
@@ -100,7 +100,7 @@ Answer: use An SCO manual writes: "The cfree routine is provided for compliance to the iBCSe2 standard and simply calls free. The num and size -arguments to cfree are not used." +arguments to cfree are not used.". .SH RETURN VALUE The SunOS version of .BR cfree ()
man3/ctime.3 +1 -1
@@ -406,7 +406,7 @@ functions shall return values in one of two static objects: a broken-down time structure and an array of type .IR char . Execution of any of the functions may overwrite the information returned -in either of these objects by any of the other functions." +in either of these objects by any of the other functions.". This can occur in the glibc implementation. .PP In many implementations, including glibc, a 0 in
man3/lseek64.3 +1 -1
@@ -140,7 +140,7 @@ When users complained about data loss caused by a miscompilation of glibc 2.1.3 added the link-time warning .PP .in +4n -"the \`llseek\' function may be dangerous; use \`lseek64\' instead." +"the \`llseek\' function may be dangerous; use \`lseek64\' instead.". .in .PP This makes this function unusable if one desires a warning-free
man3/rcmd.3 +1 -1
@@ -256,7 +256,7 @@ On failure, it returns \-1 and sets to indicate the error. The error code .BR EAGAIN -is overloaded to mean "All network ports in use." +is overloaded to mean "All network ports in use". .PP For information on the return from .BR ruserok ()
man5/passwd.5 +1 -1
@@ -123,7 +123,7 @@ Dennis Ritchie has reported: "Sometimes we sent printer output or batch jobs to the GCOS machine. The gcos field in the password file was a place to stash the information for the $IDENTcard. -Not elegant." +Not elegant.". .TP .I directory This is the user's home directory:
man7/man.7 +1 -1
@@ -181,7 +181,7 @@ of text. Below are other relevant macros and predefined strings. Unless noted otherwise, all macros cause a break (end the current line of text). -Many of these macros set or use the "prevailing indent." +Many of these macros set or use the "prevailing indent". The "prevailing indent" value is set by any macro with the parameter .I i below;
man7/pthreads.7 +1 -1
@@ -133,7 +133,7 @@ the same process as the caller.) The system may reuse a thread ID after a terminated thread has been joined, or a detached thread has terminated. POSIX says: "If an application attempts to use a thread ID whose -lifetime has ended, the behavior is undefined." +lifetime has ended, the behavior is undefined.". .SS Thread-safe functions A thread-safe function is one that can be safely (i.e., it will deliver the same results regardless of whether it is)
man7/uri.7 +1 -1
@@ -291,7 +291,7 @@ A more portable syntax is to use an empty string as the server name, for example, <file:///etc/passwd>; this form does the same thing and is easily recognized by pattern matchers and older programs as a URI. -Note that if you really mean to say "start from the current location," don't +Note that if you really mean to say "start from the current location", don't specify the scheme at all; use a relative address like <../test.txt>, which has the side-effect of being scheme-independent. An example of this scheme is <file:///etc/passwd>.
Signature · 1 line
2.30.0
Hi Alex,
Quoted 6 lines · Alejandro Colomar
This fix places periods after the closing quotes.
This is preferred practice in Great Britain,
and normative in various European languages.See "Hart's Rules",
and the "Oxford Dictionary for Writers and Editors".
Thanks for the patch. Things are a bit more complicated.
Quoted 28 lines
Found using:
$ find man? -type f \ |grep -n '^[^.].*[^."]\."' \ |less;Signed-off-by Alejandro Colomar <[email protected]>--- man2/access.2 | 2 +- man2/mknod.2 | 2 +- man2/mmap.2 | 2 +- man2/shmget.2 | 2 +- man2/vfork.2 | 2 +- man3/cfree.3 | 2 +- man3/ctime.3 | 2 +- man3/lseek64.3 | 2 +- man3/rcmd.3 | 2 +- man5/passwd.5 | 2 +- man7/man.7 | 2 +- man7/pthreads.7 | 2 +- man7/uri.7 | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-)man2/access.2 +0
-0
man2/access.2 Only access bits are checked, not the file type or contents. · line 349
Quoted 5 lines
man2/access.2 +1
-1@@ -346,7 +346,7 @@ Only access bits are checked, not the file type or contents. Therefore, if a directory is found to be writable, it probably means that files can be created in the directory, and not that the directory can be written as a file. -Similarly, a DOS file may be found to be "executable," but the +Similarly, a DOS file may be found to be "executable", but the
I did some rewording here instead.
man2/mknod.2 or · line 268
Quoted 13 lines
man2/access.2 +0
-0.BR execve (2) call will still fail. .PPman2/mknod.2 +1
-1@@ -265,7 +265,7 @@ or .I dev is not 0, the behavior of .BR mknod () -is unspecified." +is unspecified.".
The "logical" rules don't say to use /."./, I think. See
https://en.wikipedia.org/wiki/Quotation_marks_in_English#Ending_the_sentence
And since this is a question of quoted sentences(s), the period does rightfully belong inside the quotes, I think.
man2/mmap.2 at which point touching the "guard" page will result in a · line 313
Quoted 13 lines
man2/mknod.2 +0
-0However, nowadays one should never use .BR mknod () for this purpose; one should useman2/mmap.2 +1
-1@@ -310,7 +310,7 @@ at which point touching the "guard" page will result in a signal. .TP .BR MAP_HUGETLB " (since Linux 2.6.32)" -Allocate the mapping using "huge pages." +Allocate the mapping using "huge pages".
I did some rewording here instead.
man2/shmget.2 to ensure that this call creates the segment. · line 120
Quoted 13 lines
man2/mmap.2 +0
-0See the Linux kernel source file .I Documentation/admin\-guide/mm/hugetlbpage.rst for further information, as well as NOTES, below.man2/shmget.2 +1
-1@@ -117,7 +117,7 @@ to ensure that this call creates the segment. If the segment already exists, the call fails. .TP .BR SHM_HUGETLB " (since Linux 2.6)" -Allocate the segment using "huge pages." +Allocate the segment using "huge pages".
I did some rewording here instead.
man2/vfork.2 or · line 314
Quoted 13 lines
man2/shmget.2 +0
-0See the Linux kernel source file .I Documentation/admin\-guide/mm/hugetlbpage.rst for further information.man2/vfork.2 +1
-1@@ -311,7 +311,7 @@ or .B SIGTTIN signals; rather, output or .IR ioctl s -are allowed and input attempts result in an end-of-file indication." +are allowed and input attempts result in an end-of-file indication.".
See above. (mknod(2))
man3/cfree.3 Answer: use · line 103
Quoted 13 lines
man2/vfork.2 +0
-0.\" .\" As far as I can tell, the following is not true in 2.6.19: .\" Currently (Linux 2.3.25),man3/cfree.3 +1
-1@@ -100,7 +100,7 @@ Answer: use An SCO manual writes: "The cfree routine is provided for compliance to the iBCSe2 standard and simply calls free. The num and size -arguments to cfree are not used." +arguments to cfree are not used.".
See above. (mknod(2))
Quoted 8 lines
man3/cfree.3 +0
-0.SH RETURN VALUE The SunOS version of .BR cfree ()man3/ctime.3 +0
-0
man3/ctime.3 functions shall return values in one of two static objects: · line 410
Quoted 6 lines
man3/ctime.3 +1
-1@@ -406,7 +406,7 @@ functions shall return values in one of two static objects: a broken-down time structure and an array of type .IR char . Execution of any of the functions may overwrite the information returned -in either of these objects by any of the other functions." +in either of these objects by any of the other functions.". This can occur in the glibc implementation.
See above. (mknod(2))
man3/lseek64.3 When users complained about data loss caused by a miscompilation of · line 143
Quoted 12 lines
man3/ctime.3 +0
-0.PP In many implementations, including glibc, a 0 inman3/lseek64.3 +1
-1@@ -140,7 +140,7 @@ When users complained about data loss caused by a miscompilation of glibc 2.1.3 added the link-time warning .PP .in +4n -"the \`llseek\' function may be dangerous; use \`lseek64\' instead." +"the \`llseek\' function may be dangerous; use \`lseek64\' instead.".
No. This really is exactly the string that glibc used to produce!
man3/rcmd.3 On failure, it returns \-1 and sets · line 259
Quoted 13 lines
man3/lseek64.3 +0
-0.in .PP This makes this function unusable if one desires a warning-freeman3/rcmd.3 +1
-1@@ -256,7 +256,7 @@ On failure, it returns \-1 and sets to indicate the error. The error code .BR EAGAIN -is overloaded to mean "All network ports in use." +is overloaded to mean "All network ports in use".
Changed.
man5/passwd.5 Dennis Ritchie has reported: "Sometimes we sent printer output or · line 126
Quoted 13 lines
man3/rcmd.3 +0
-0.PP For information on the return from .BR ruserok ()man5/passwd.5 +1
-1@@ -123,7 +123,7 @@ Dennis Ritchie has reported: "Sometimes we sent printer output or batch jobs to the GCOS machine. The gcos field in the password file was a place to stash the information for the $IDENTcard. -Not elegant." +Not elegant.".
See above. (mknod(2))
man7/man.7 of text. · line 184
Quoted 13 lines
man5/passwd.5 +0
-0.TP .I directory This is the user's home directory:man7/man.7 +1
-1@@ -181,7 +181,7 @@ of text. Below are other relevant macros and predefined strings. Unless noted otherwise, all macros cause a break (end the current line of text). -Many of these macros set or use the "prevailing indent." +Many of these macros set or use the "prevailing indent".
Changed.
man7/pthreads.7 the same process as the caller.) · line 136
Quoted 13 lines
man7/man.7 +0
-0The "prevailing indent" value is set by any macro with the parameter .I i below;man7/pthreads.7 +1
-1@@ -133,7 +133,7 @@ the same process as the caller.) The system may reuse a thread ID after a terminated thread has been joined, or a detached thread has terminated. POSIX says: "If an application attempts to use a thread ID whose -lifetime has ended, the behavior is undefined." +lifetime has ended, the behavior is undefined.".
See above. (mknod(2))
man7/uri.7 A more portable syntax is to use an empty string as the server name, · line 294
Quoted 13 lines
man7/pthreads.7 +0
-0.SS Thread-safe functions A thread-safe function is one that can be safely (i.e., it will deliver the same results regardless of whether it is)man7/uri.7 +1
-1@@ -291,7 +291,7 @@ A more portable syntax is to use an empty string as the server name, for example, <file:///etc/passwd>; this form does the same thing and is easily recognized by pattern matchers and older programs as a URI. -Note that if you really mean to say "start from the current location," don't +Note that if you really mean to say "start from the current location", don't
Changed.
man7/uri.7 A more portable syntax is to use an empty string as the server name, · line 297
Quoted 3 lines
man7/uri.7 +0
-0specify the scheme at all; use a relative address like <../test.txt>, which has the side-effect of being scheme-independent. An example of this scheme is <file:///etc/passwd>.
I see now that the logical system was already (by quite a margine) the majority usage in the manual pages.
Cheers,
Michael
Signature · 3 lines
Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/
Hi Michael,
Quoted 35 lines · Michael Kerrisk (man-pages)
Hi Alex,
Quoted 6 lines · Alejandro Colomar
This fix places periods after the closing quotes.
This is preferred practice in Great Britain,
and normative in various European languages.See "Hart's Rules",
and the "Oxford Dictionary for Writers and Editors".Thanks for the patch. Things are a bit more complicated.
Quoted 23 lines
Found using:
$ find man? -type f \ |grep -n '^[^.].*[^."]\."' \ |less;Signed-off-by Alejandro Colomar <[email protected]>--- man2/access.2 | 2 +- man2/mknod.2 | 2 +- man2/mmap.2 | 2 +- man2/shmget.2 | 2 +- man2/vfork.2 | 2 +- man3/cfree.3 | 2 +- man3/ctime.3 | 2 +- man3/lseek64.3 | 2 +- man3/rcmd.3 | 2 +- man5/passwd.5 | 2 +- man7/man.7 | 2 +- man7/pthreads.7 | 2 +- man7/uri.7 | 2 +- 13 files changed, 13 insertions(+), 13 deletions(-)
Quoted 12 lines
man2/access.2 Only access bits are checked, not the file type or contents. · line 349
Quoted 10 lines
man2/access.2 +1
-1@@ -346,7 +346,7 @@ Only access bits are checked, not the file type or contents. Therefore, if a directory is found to be writable, it probably means that files can be created in the directory, and not that the directory can be written as a file. -Similarly, a DOS file may be found to be "executable," but the +Similarly, a DOS file may be found to be "executable", but theI did some rewording here instead.
Okay
Quoted 18 lines
Quoted 9 lines
man2/access.2 +0
-0.BR execve (2) call will still fail. .PPman2/mknod.2 +0
-0man2/mknod.2 or · line 268
Quoted 5 lines
man2/mknod.2 +1
-1@@ -265,7 +265,7 @@ or .I dev is not 0, the behavior of .BR mknod () -is unspecified." +is unspecified.".The "logical" rules don't say to use /."./, I think. See
https://en.wikipedia.org/wiki/Quotation_marks_in_English#Ending_the_sentence
Quoted 2 lines
And since this is a question of quoted sentences(s), the period does rightfully belong inside the quotes, I think.
After checking with the Spanish rules
(<https://www.rae.es/dpd/comillas>, see 3.c):
* original quoted punctuation is kept inside the quotes
xxx." * if the outer sentence has punctuation, it's written outside the quotes: xxx". * If both points above happen at the same time, both are written; they are independent. HOWEVER, if that would end up with [.".], the inner period is removed: xxx". (not [xxx.".]) But: xxx?". xxx."? xxx...".
I guess neither British nor Spanish are completely logical in this specific situation, because one of the punctuation is missing:
Spanish: The original quoted period is missing.
English: How do you know if the outer sentence has ended if there's no period outside the quotes?
Meh...
Quoted 16 lines
Quoted 9 lines
man2/mknod.2 +0
-0However, nowadays one should never use .BR mknod () for this purpose; one should useman2/mmap.2 +0
-0man2/mmap.2 at which point touching the "guard" page will result in a · line 313
Quoted 5 lines
man2/mmap.2 +1
-1@@ -310,7 +310,7 @@ at which point touching the "guard" page will result in a signal. .TP .BR MAP_HUGETLB " (since Linux 2.6.32)" -Allocate the mapping using "huge pages." +Allocate the mapping using "huge pages".I did some rewording here instead.
Okay
Quoted 16 lines
Quoted 9 lines
man2/mmap.2 +0
-0See the Linux kernel source file .I Documentation/admin\-guide/mm/hugetlbpage.rst for further information, as well as NOTES, below.man2/shmget.2 +0
-0man2/shmget.2 to ensure that this call creates the segment. · line 120
Quoted 5 lines
man2/shmget.2 +1
-1@@ -117,7 +117,7 @@ to ensure that this call creates the segment. If the segment already exists, the call fails. .TP .BR SHM_HUGETLB " (since Linux 2.6)" -Allocate the segment using "huge pages." +Allocate the segment using "huge pages".I did some rewording here instead.
.
Quoted 16 lines
Quoted 9 lines
man2/shmget.2 +0
-0See the Linux kernel source file .I Documentation/admin\-guide/mm/hugetlbpage.rst for further information.man2/vfork.2 +0
-0man2/vfork.2 or · line 314
Quoted 5 lines
man2/vfork.2 +1
-1@@ -311,7 +311,7 @@ or .B SIGTTIN signals; rather, output or .IR ioctl s -are allowed and input attempts result in an end-of-file indication." +are allowed and input attempts result in an end-of-file indication.".See above. (mknod(2))
See above.
Quoted 16 lines
Quoted 9 lines
man2/vfork.2 +0
-0.\" .\" As far as I can tell, the following is not true in 2.6.19: .\" Currently (Linux 2.3.25),man3/cfree.3 +0
-0man3/cfree.3 Answer: use · line 103
Quoted 5 lines
man3/cfree.3 +1
-1@@ -100,7 +100,7 @@ Answer: use An SCO manual writes: "The cfree routine is provided for compliance to the iBCSe2 standard and simply calls free. The num and size -arguments to cfree are not used." +arguments to cfree are not used.".See above. (mknod(2))
.
Quoted 17 lines
Quoted 9 lines
man3/cfree.3 +0
-0.SH RETURN VALUE The SunOS version of .BR cfree ()man3/ctime.3 +0
-0man3/ctime.3 functions shall return values in one of two static objects: · line 410
Quoted 6 lines
man3/ctime.3 +1
-1@@ -406,7 +406,7 @@ functions shall return values in one of two static objects: a broken-down time structure and an array of type .IR char . Execution of any of the functions may overwrite the information returned -in either of these objects by any of the other functions." +in either of these objects by any of the other functions.". This can occur in the glibc implementation.See above. (mknod(2))
.
Quoted 15 lines
man3/lseek64.3 When users complained about data loss caused by a miscompilation of · line 143
Quoted 13 lines
man3/ctime.3 +0
-0.PP In many implementations, including glibc, a 0 inman3/lseek64.3 +1
-1@@ -140,7 +140,7 @@ When users complained about data loss caused by a miscompilation of glibc 2.1.3 added the link-time warning .PP .in +4n -"the \`llseek\' function may be dangerous; use \`lseek64\' instead." +"the \`llseek\' function may be dangerous; use \`lseek64\' instead.".No. This really is exactly the string that glibc used to produce!
Okay
Quoted 16 lines
Quoted 9 lines
man3/lseek64.3 +0
-0.in .PP This makes this function unusable if one desires a warning-freeman3/rcmd.3 +0
-0man3/rcmd.3 On failure, it returns \-1 and sets · line 259
Quoted 5 lines
man3/rcmd.3 +1
-1@@ -256,7 +256,7 @@ On failure, it returns \-1 and sets to indicate the error. The error code .BR EAGAIN -is overloaded to mean "All network ports in use." +is overloaded to mean "All network ports in use".Changed.>
Quoted 15 lines
man5/passwd.5 Dennis Ritchie has reported: "Sometimes we sent printer output or · line 126
Quoted 13 lines
man3/rcmd.3 +0
-0.PP For information on the return from .BR ruserok ()man5/passwd.5 +1
-1@@ -123,7 +123,7 @@ Dennis Ritchie has reported: "Sometimes we sent printer output or batch jobs to the GCOS machine. The gcos field in the password file was a place to stash the information for the $IDENTcard. -Not elegant." +Not elegant.".See above. (mknod(2))
See above.
Quoted 17 lines
Quoted 9 lines
man5/passwd.5 +0
-0.TP .I directory This is the user's home directory:man7/man.7 +0
-0man7/man.7 of text. · line 184
Quoted 5 lines
man7/man.7 +1
-1@@ -181,7 +181,7 @@ of text. Below are other relevant macros and predefined strings. Unless noted otherwise, all macros cause a break (end the current line of text). -Many of these macros set or use the "prevailing indent." +Many of these macros set or use the "prevailing indent".Changed.
Quoted 15 lines
man7/pthreads.7 the same process as the caller.) · line 136
Quoted 13 lines
man7/man.7 +0
-0The "prevailing indent" value is set by any macro with the parameter .I i below;man7/pthreads.7 +1
-1@@ -133,7 +133,7 @@ the same process as the caller.) The system may reuse a thread ID after a terminated thread has been joined, or a detached thread has terminated. POSIX says: "If an application attempts to use a thread ID whose -lifetime has ended, the behavior is undefined." +lifetime has ended, the behavior is undefined.".See above. (mknod(2))
.
Quoted 21 lines
Quoted 9 lines
man7/pthreads.7 +0
-0.SS Thread-safe functions A thread-safe function is one that can be safely (i.e., it will deliver the same results regardless of whether it is)man7/uri.7 +0
-0man7/uri.7 A more portable syntax is to use an empty string as the server name, · line 294
Quoted 5 lines
man7/uri.7 +1
-1@@ -291,7 +291,7 @@ A more portable syntax is to use an empty string as the server name, for example, <file:///etc/passwd>; this form does the same thing and is easily recognized by pattern matchers and older programs as a URI. -Note that if you really mean to say "start from the current location," don't +Note that if you really mean to say "start from the current location", don'tChanged.
man7/uri.7 A more portable syntax is to use an empty string as the server name, · line 297
Quoted 3 lines
man7/uri.7 +0
-0specify the scheme at all; use a relative address like <../test.txt>, which has the side-effect of being scheme-independent. An example of this scheme is <file:///etc/passwd>.
Quoted 8 lines
I see now that the logical system was already (by quite a margine) the majority usage in the manual pages.
Cheers,
Michael
Cheers,
Alex
Signature · 3 lines
Alejandro Colomar Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/ http://www.alejandro-colomar.es/