From: Alejandro Colomar <alx.manpages@gmail.com>
To: "Thaddeus H . Black" <thb@debian.org>
Cc: Alejandro Colomar <alx.manpages@gmail.com>,
"G . Branden Robinson" <g.branden.robinson@gmail.com>,
Michael Kerrisk <mtk.manpages@gmail.com>,
linux-man@vger.kernel.org
Subject: [PATCH 1/3] Remove unnecessary .P after .S[HS]
Date: Thu, 9 Sep 2021 09:24:40 +0200 [thread overview]
Message-ID: <20210909072442.423117-2-alx.manpages@gmail.com> (raw)
In-Reply-To: <YTluPPbquS6ZHmHL@b-tk.org>
Cc: Thaddeus H. Black <thb@debian.org>
Cc: G. Branden Robinson <g.branden.robinson@gmail.com>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>
Cc: linux-man@vger.kernel.org
---
man7/filename.7 | 16 ----------------
1 file changed, 16 deletions(-)
diff --git a/man7/filename.7 b/man7/filename.7
index 04ad9addb..ec9cd8b09 100644
--- a/man7/filename.7
+++ b/man7/filename.7
@@ -27,10 +27,8 @@
.\"
.TH FILENAME 7 2021-09-06 "Linux" "Linux Programmer's Manual"
.SH NAME
-.P
filename \- requirements and conventions for the naming of files
.SH DESCRIPTION
-.P
This manual page sets forth requirements for and delineates conventions
regarding filenames on a Linux system, where a
.I filename
@@ -38,7 +36,6 @@ is either (as the word suggests) the name of a regular file or the name of
another object held by the system's filesystem such as a directory,
symbolic link, named pipe or device.
.SH LEGAL FILENAMES
-.P
A filename on a Linux system can consist of almost any sequence of UTF-8
characters or, indeed, almost any sequence of bytes.
The exceptions are as follows.
@@ -110,20 +107,17 @@ whereas
would mean
.IR /home/jsmith/foo/bar/baz .
.SS Long names
-.P
No filename may exceed\~255 bytes in length, or\~256 bytes after counting
the terminating null byte.
.RB ( Reserved
.B characters
above explains the terminating null byte.)
.SS Non-UTF-8 names
-.P
Filenames need not consist of valid UTF-8 characters (although, except
where a non-UTF-8 legacy encoding is in use, most filenames do).
As long as the requirements of the preceding subsections are met, any
sequence of bytes can legally serve as a filename.
.SH CONVENTIONAL FILENAMES
-.P
Merely because a filename is legal does not make its use advisable, though.
Some legal filenames cause practical troubles.
For example, the legal filenames
@@ -145,7 +139,6 @@ It also makes filenames more recognizable to experienced users.
.P
This section introduces broadly observed conventions for filenames.
.SS The POSIX Portable Filename Character Set
-.P
In general contexts, especially for international applications,
conventional filenames are composed using the\~65 ASCII characters of the
POSIX Portable Filename Character Set.
@@ -199,7 +192,6 @@ see
.B Capitalization
below for further observations regarding capitalization.)
.SS Special semantics
-.P
Besides the last subsection's POSIX convention, a pair of conventions
derived from core utilities is almost always respected, as well.
.TP
@@ -229,7 +221,6 @@ been mentioned under
.B LEGAL FILENAMES
above: one cannot use it as a file's proper name at all.
.SS The full stop to introduce a format extension
-.P
Other than at a filename's beginning (a case the last subsection has
discussed), the full stop is employed in filenames for various further
conventional purposes.
@@ -275,14 +266,12 @@ implies, on your machine in a file such as
or
.IR /usr/share/mime/globs .)
.SH SOFT CONVENTIONS
-.P
Further filenaming conventions are softer.
Though often observed, such softer conventions can be bent or broken
without rendering filenames unconventional.
.P
This section introduces soft conventions for filenames.
.SS Low line versus hyphen-minus
-.P
Whether to use the low line\~\fB\_\fR or the hyphen-minus\~\fB\-\fR in
filenames is a matter of preference.
Except as stated above, convention does not strongly prefer the one over
@@ -343,7 +332,6 @@ Sometimes, the low line stands for an unspecified letter of the alphabet.
Otherwise, despite that the low line and the hyphen-minus are both
conventional, if you want advice: prefer the hyphen-minus.
.SS Capitalization
-.P
A loosely observed convention favors small letters in filenames where no
reason to use capitals exists.
Many exceptions occur, though, as for example the oft-encountered
@@ -385,7 +373,6 @@ state a general rule.
.\" might be demoted to a subsection and, if appropriate, grouped with the
.\" new subsection together under a new section
.\" entitled "FURTHER CONSIDERATIONS."
-.P
If your application is local rather than international, then you can relax
POSIX's aforementioned character-set convention at your discretion by
including graphic Unicode characters; specifically, by including non-ASCII
@@ -428,7 +415,6 @@ and\~\fB\eu3000\fR is probably also inadvisable, but
.BR iswgraph (3)
returns false for those, anyway.]
.SH UNCONVENTIONAL FILENAMES
-.P
More than a few files on a typical Linux system, occasionally even
including standard files employed by and/or automatically installed by an
operating-system distribution, have unconventional filenames.
@@ -496,10 +482,8 @@ Spaces in filenames are unconventional and perhaps inadvisable, but they
are hardly unusual; whereas tabs and line feeds are, for good reason,
practically never seen.)
.SH CONFORMING TO
-.P
POSIX.1-2008, SUSv4.
.SH SEE ALSO
-.P
.BR ls (1),
.BR sh (1),
.BR iswcntrl (3),
--
2.33.0
next prev parent reply other threads:[~2021-09-09 7:24 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-06 11:40 [PATCH] filename.7: new manual page Thaddeus H. Black
2021-09-06 14:21 ` Alejandro Colomar (man-pages)
2021-09-06 16:59 ` G. Branden Robinson
2021-09-06 21:47 ` Alejandro Colomar (man-pages)
2021-09-08 3:54 ` G. Branden Robinson
2021-09-08 14:56 ` Thaddeus H. Black
2021-09-08 15:45 ` Alejandro Colomar (man-pages)
2021-09-09 2:15 ` Thaddeus H. Black
2021-09-09 2:45 ` Thaddeus H. Black
2021-09-09 7:24 ` Alejandro Colomar [this message]
2021-09-09 7:24 ` [PATCH 2/3] Fix indentation of paragraph, which continues talking about \0 Alejandro Colomar
2021-09-09 7:24 ` [PATCH 3/3] Use subsections instead of sections Alejandro Colomar
2021-09-09 7:28 ` [PATCH] .P -> .PP Alejandro Colomar
2021-09-12 14:20 ` [PATCH 3/3] Use subsections instead of sections Thaddeus H. Black
2021-09-12 14:49 ` Alejandro Colomar (man-pages)
2021-09-12 14:56 ` Alejandro Colomar (man-pages)
2021-09-12 15:22 ` Thaddeus H. Black
2021-09-12 18:49 ` G. Branden Robinson
2021-09-12 18:12 ` G. Branden Robinson
2021-09-12 22:39 ` Alejandro Colomar (man-pages)
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210909072442.423117-2-alx.manpages@gmail.com \
--to=alx.manpages@gmail.com \
--cc=g.branden.robinson@gmail.com \
--cc=linux-man@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
--cc=thb@debian.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox