diff options
| author | Alejandro Colomar <alx@kernel.org> | 2023-08-17 22:47:16 +0200 |
|---|---|---|
| committer | Alejandro Colomar <alx@kernel.org> | 2023-08-17 23:12:31 +0200 |
| commit | 0569afbbccd6de28d1bacd13471a679ad2674aa1 (patch) | |
| tree | e0286e2d8dee88465fc9e2b31697573af0aa10cf /man5/proc_pid_environ.5 | |
| parent | 29597f1e7ecd58e8239a1650c6bdea0517f913af (diff) | |
| parent | 92cdcec79df039146e5ed42cac23cd4b7e3f9e25 (diff) | |
| download | man-pages-0569afbbccd6.tar.gz | |
proc*.5: Make sashimi
[Merge tag 'proc-sashimi-v1' of <git://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git>]
proc(5) was a huge page, which was quite hard to maintain, extend, read,
and refer to. Split the page into small pages for the different
directories and files within /proc. Some pages are still too large
(e.g., proc_sys(5)), and will some day be split even more.
This split keeps the contents of the original page, without modifying
anything; not even the formatting.
The only thing that has been modified in this patches, is that
directories are consistently represented with a trailing slash.
For the file name of the pages, we've used the name of the interface
(e.g., /proc/pid/), removing the leading and trailing '/'s and then
translating the remaining ones as `tr / _` (e.g., proc_pid.5). The
title of the pages (TH) is consistent with this. The NAME of the pages,
however, is the actual path name of the interfaces.
The man page references have not been updated, as that was a more
complex and tedious work, so I expect that they'll be slowly updated as
we and users find out.
Link: <https://lore.kernel.org/linux-man/e3a5bc09-e835-9819-4aaa-12959495ac59@kernel.org/T/>
Acked-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
Acked-by: Günther Noack <gnoack@google.com>
Acked-by: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: Brian Inglis <Brian.Inglis@Shaw.ca>
Cc: Ingo Schwarze <schwarze@usta.de>
Cc: Colin Watson <cjwatson@debian.org>
Signed-off-by: Alejandro Colomar <alx@kernel.org>
Diffstat (limited to 'man5/proc_pid_environ.5')
| -rw-r--r-- | man5/proc_pid_environ.5 | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/man5/proc_pid_environ.5 b/man5/proc_pid_environ.5 new file mode 100644 index 0000000000..0ff8d48294 --- /dev/null +++ b/man5/proc_pid_environ.5 @@ -0,0 +1,48 @@ +.\" Copyright (C) 1994, 1995, Daniel Quinlan <quinlan@yggdrasil.com> +.\" Copyright (C) 2002-2008, 2017, Michael Kerrisk <mtk.manpages@gmail.com> +.\" Copyright (C) 2023, Alejandro Colomar <alx@kernel.org> +.\" +.\" SPDX-License-Identifier: GPL-3.0-or-later +.\" +.TH proc_pid_environ 5 (date) "Linux man-pages (unreleased)" +.SH NAME +/proc/pid/environ \- initial environment +.SH DESCRIPTION +.TP +.IR /proc/ pid /environ +This file contains the initial environment that was set +when the currently executing program was started via +.BR execve (2). +The entries are separated by null bytes (\[aq]\e0\[aq]), +and there may be a null byte at the end. +Thus, to print out the environment of process 1, you would do: +.IP +.in +4n +.EX +.RB "$" " cat /proc/1/environ | tr \[aq]\e000\[aq] \[aq]\en\[aq]" +.EE +.in +.IP +If, after an +.BR execve (2), +the process modifies its environment +(e.g., by calling functions such as +.BR putenv (3) +or modifying the +.BR environ (7) +variable directly), +this file will +.I not +reflect those changes. +.IP +Furthermore, a process may change the memory location that this file refers via +.BR prctl (2) +operations such as +.BR PR_SET_MM_ENV_START . +.IP +Permission to access this file is governed by a ptrace access mode +.B PTRACE_MODE_READ_FSCREDS +check; see +.BR ptrace (2). +.SH SEE ALSO +.BR proc (5) |