Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduction to File Formats - 21st Century BSD #1534

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+23 −6
Open

Introduction to File Formats - 21st Century BSD #1534

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ce4ef86
intro.5: add local to files, minor maintenence
concussious Nov 17, 2024
2d05d6a
intro.5: import description table from OpenBSD
concussious Nov 17, 2024
e640de4
intro.5: more verbose introductory sentence
concussious Nov 17, 2024
ae366a1
intro.5: Bx typo (squash)
concussious Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions share/man/man5/intro.5
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.\"-
.\" SPDX-License-Identifier: BSD-3-Clause
.\"
.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
.\"
Expand Down Expand Up @@ -25,18 +28,30 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.Dd February 16, 1997
.Dd November 17, 2024
.Dt INTRO 5
.Os
.Sh NAME
.Nm intro
.Nd "introduction to file formats"
.Nd introduction to file formats
.Sh DESCRIPTION
This section contains information about file formats.
This section contains information about the file formats
which comprise most data structures in the BSD environment, including:
concussious marked this conversation as resolved.
Show resolved Hide resolved
.Pp
.Bl -bullet -compact
.It

Check warning on line 42 in share/man/man5/intro.5

View workflow job for this annotation

GitHub Actions / Style Checker 

Missing Signed-off-by: line

Check warning on line 42 in share/man/man5/intro.5

View workflow job for this annotation

GitHub Actions / Style Checker 

Missing Signed-off-by: line

Check warning on line 42 in share/man/man5/intro.5

View workflow job for this annotation

GitHub Actions / Style Checker 

Missing Signed-off-by: line
ASCII configuration and resource files
.It
System binary file and stream structures
.It
Composition of database files

Check warning on line 47 in share/man/man5/intro.5

View workflow job for this annotation

GitHub Actions / Style Checker 

Missing Signed-off-by: line

Check warning on line 47 in share/man/man5/intro.5

View workflow job for this annotation

GitHub Actions / Style Checker 

Missing Signed-off-by: line

Check warning on line 47 in share/man/man5/intro.5

View workflow job for this annotation

GitHub Actions / Style Checker 

Missing Signed-off-by: line
.El
.Sh FILES
.Bl -tag -width /etc/shells -compact
.It Pa /etc
location of most system configuration files
.Bl -tag -width "/usr/local/etc/" -compact

Check warning on line 50 in share/man/man5/intro.5

View workflow job for this annotation

GitHub Actions / Style Checker 

Missing Signed-off-by: line

Check warning on line 50 in share/man/man5/intro.5

View workflow job for this annotation

GitHub Actions / Style Checker 

Missing Signed-off-by: line

Check warning on line 50 in share/man/man5/intro.5

View workflow job for this annotation

GitHub Actions / Style Checker 

Missing Signed-off-by: line
.It Pa /etc/
location of most base system configuration files
.It Pa /usr/local/etc/
location of installed component configuration files
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i appreciate there's a desire to be terse here, but this wording seems a bit odd to me.

for unfortunate historical reasons, /usr/local/etc contains two separate, unrelated types of file:

  • user-created configuration files for locally-installed software
  • configuration files for software installed from FreeBSD ports/packages

however:

  • not every 'installed component' is guaranteed to go to /usr/local/etc (e.g. pkgsrc, OpenPKG)
  • the installation prefix of ports (LOCALBASE) can be changed when building them

perhaps this could be written as something like:

typical location of configuration files for locally-installed software, and default location of configuration files for software installed from FreeBSD ports

(or, you know, something less awkward -- there's a reason i'm not a doc author.)

and an Xr to hier(7) might not hurt there to explain /usr/local more generally.

.El
.Sh SEE ALSO
.Xr apropos 1 ,
Expand Down