1
1
mirror of https://github.com/systemd/systemd-stable.git synced 2025-01-11 05:17:44 +03:00
Commit Graph

6869 Commits

Author SHA1 Message Date
Lennart Poettering
d1066f33b5 man: document restrictions on naming interfaces
Let's document that "." is a bad choice of character when naming
interfaces. Let's also document the hard restrictions we make when
naming interfaces.

Result of the mess that is #25052.

(cherry picked from commit 8f598a4635)
2022-10-24 20:48:11 +02:00
anarcat
78a8e938e4 man/shutdown: document how to switch to single-user mode
Before Debian switched to systemd, `shutdown now` would reset the system into
single user mode, doing roughly the equivalent of `telinit 1`.

Now, systemd's `shutdown` command does not behave that way; it defaults to
`poweroff` which might be confusing for users (like me) used to the previous
method.

Because I don't use the command often, I keep being stumped by this behavior,
and every time I look at the `shutdown(1)` manpage, I don't understand why I
can't find what I am looking for. This patch should make sure that people like
me find their way back to some sort of reason.

Maybe the *proper* way to fix this would be to restore the more classic
behavior, but I'm definitely not going to climb that hill. Besides, I clearly
remember the time I found out about the `shutdown` command and was *really*
confused when it brought me back to a command-line prompt. That was really
counter-intuitive and I find that change to actually be a good thing. So I'm
not proposing to change this behavior, merely document it better.

I originally added this to the `-P` option but it was suggested adding a new
`COMPATIBILITY` section instead, where other such issues could be added.

The `COMPATIBILITY` section is not actually officially documented. `man(1)`
talks about a `CONFORMING TO` section, but `shutdown(1)` is not
POSIX (`shutdown(2)` is, of course), so there's no actual standard on how this
should work.

The other option I considered was to add a `BUGS` section, but that seemed to
inflammatory, and definitely counter-productive.

(cherry picked from commit 9aafd310cc)
2022-10-13 22:53:23 +02:00
Lennart Poettering
c4fd38f7d2 man: document the Dump() calls of the PID 1 D-Bus interface, and what they are
(cherry picked from commit 0df8512124)
2022-10-01 19:05:54 +02:00
Yu Watanabe
054cad0097 man: explicitly document that "reboot -f" is different from "systemctl reboot -f"
Closes #24696.

(cherry picked from commit cb19517490)
2022-10-01 19:05:54 +02:00
Jade Bilkey
44660d2e12 man: fix static bridge example
A NetDev is needed to create the bridge in order to match the example's description "This creates a bridge..."

(cherry picked from commit bc33789a06)
2022-10-01 19:05:54 +02:00
Zhaofeng Li
cd2fad2300 virt: Support detection of Apple Virtualization.framework guests
(cherry picked from commit f555830674)
2022-10-01 19:05:53 +02:00
David Jaša
951e99231e check-os-release.py compatible with Python < 3.8
The ":=" operator was only added in Python 3.8 so splitting the line with it into two makes check-os-release.py actually fulfill its claim of working with any python version.

(cherry picked from commit ce0a056abc)
2022-10-01 19:05:53 +02:00
Antonio Alvarez Feijoo
ada437cfb1 sysext: add missing COMMAND to the help output and man synopsis
(cherry picked from commit 782e41ab88)
2022-10-01 19:05:53 +02:00
Daan De Meyer
3814bd0e71 man: Clarify that tools should prefer mount units over editing fstab
(cherry picked from commit 29e804dffd)
2022-08-08 10:59:25 +02:00
Lennart Poettering
6b58b06c7d man: fix docbook
(cherry picked from commit 1374f5a03a)
2022-08-08 10:59:24 +02:00
Lennart Poettering
0cfe2d7e88 systemctl: clarify that "status" is about the most recent invocation of a service
And point people to "journalctl --unit=" for information of prior runs.

Inspired by: #24159

(cherry picked from commit 157cb4337b)
2022-08-08 10:56:45 +02:00
Max Gautier
79de67e2df docs: Correct StandartOutput documentation
fix #2114

(cherry picked from commit e0a12b9634)
2022-08-08 10:53:02 +02:00
Kai Lueke
fbf4050e2c man: Use correct target type for sysupdate entry
While Type=file works because it seems to be the default, the line gets
ignored as printed on the stderr output.
Use the correct value "regular-file" for the target type.

(cherry picked from commit 0ad7b7b809)
2022-08-08 10:27:45 +02:00
Ulrich Ölmann
a4a04055f8 man: document udevadm lock's exit code
(cherry picked from commit aa386add67)
2022-08-08 10:27:45 +02:00
Jan Janssen
8d688da26d man: Miscellaneous fixes
Fixes: #24056
(cherry picked from commit 6a1d8f1161)
2022-08-08 10:27:45 +02:00
Ansgar Burchardt
bf9e8207df man/system-or-user-ns.xml: explicitly refer to PrivateUsers= option
It is not clear what "unprivileged user namespaces are available" means.
It could mean either that they are only usable, that is, enabled in the kernel,
or they have been enabled for the specific service. Referring to the
`PrivateUsers=` options makes it clear that the latter is meant.

(cherry picked from commit 34aee208b5)
2022-08-08 10:27:45 +02:00
Vito Caputo
110d49d151 man: fix grammatical error in --cursor-file description
Just a minor cleanup to fix unparseable wording

(cherry picked from commit 729d2df806)
2022-08-08 10:27:45 +02:00
Zbigniew Jędrzejewski-Szmek
b7c5530a1f man: fix formatting of "BARRIER=1"
Whitespace inside of the <varname> field was propagated to the displayed form,
causing strange indentation.

(cherry picked from commit 9cfc294fe0)
2022-08-08 10:27:44 +02:00
lastkrick
7632ff4ccc man: fix typo in systemd.network documentation in IPv6RoutePrefix section (#24030)
(cherry picked from commit 69a7d10832)
2022-08-08 10:27:44 +02:00
Lennart Poettering
724d52146a man: explain why various resource limits don't make sense and should not be used.
(cherry picked from commit 8c88895772)
2022-08-08 10:27:44 +02:00
Lennart Poettering
83203873ee man: drop misplaced ','
(cherry picked from commit 3840b14781)
2022-08-08 10:27:44 +02:00
Andre Kalb
098d70f438 man/network: ServerAddress= drop "literal" from IP address ranges
(cherry picked from commit 1df6201882)
2022-08-08 10:27:44 +02:00
Zbigniew Jędrzejewski-Szmek
a4af8592c6 man: lift pam_systemd_homed description to Summary
Also change the title to describe the module more comprehensively.
Follow-up for 90bc309aa2. Suggested
in https://bugzilla.redhat.com/show_bug.cgi?id=2085485#c5.

(cherry picked from commit 9e6df03412)
2022-08-08 09:57:47 +02:00
Lennart Poettering
69de3e810a man: explain why pam_systemd_home wants to be in all four stacks
Suggested here:

https://bugzilla.redhat.com/show_bug.cgi?id=2085485#c5
(cherry picked from commit 90bc309aa2)
2022-08-08 09:54:15 +02:00
Zbigniew Jędrzejewski-Szmek
a385019e58 systemctl: stop saying "vendor preset"
We have vendor presets, and local admin presets, and runtime presets
(under /usr/lib, /usr/local/lib and /etc, /run, respectively). When we
display preset state, it can be configured in any of those places, so
we shouldn't say anything about the origin.

(Another nice advantage is that it improves alignment:

[root@f36 ~]# systemctl list-unit-files multipathd.service
UNIT FILE          STATE   VENDOR PRESET
multipathd.service enabled enabled

^ this looks we have a "PRESET" column that is empty.)

(cherry picked from commit c1e0dc9c88)
2022-07-13 13:12:31 +02:00
Lennart Poettering
81d33ab7f6 man: "enabled commands are started at boot" is rubbish
it's enabled units, and they might be started by various forms of
activation, not just "at boot".

Fix that.

(cherry picked from commit 0c772b1cc1)
2022-07-13 13:12:31 +02:00
Antonio Alvarez Feijoo
98a39c3014 man: add missing arguments to systemd-creds synopsis
(cherry picked from commit 5ad0109cd8)
2022-06-02 20:07:11 +02:00
Zbigniew Jędrzejewski-Szmek
cfd6a14c7d man/homectl: adjust man page to match code
Fixes #22966. Since there are competing conventions, let's not
change our code, but make the docs match what is implemented.

(cherry picked from commit b72308d344)
2022-06-02 20:04:06 +02:00
Zbigniew Jędrzejewski-Szmek
11b8069929 man/sd-bus: discuss negative-return values and add example
Fixes #22816.

(cherry picked from commit 8f24777156)
2022-06-02 20:04:06 +02:00
Zbigniew Jędrzejewski-Szmek
7c2b2f279c man/shutdown: explain -h more
Fixes #23401

(cherry picked from commit 5ee38adea4)
2022-06-02 20:04:06 +02:00
Zbigniew Jędrzejewski-Szmek
7a73f995e2 man/automount: say that automounts should not be nested
Fixes #21832.

(cherry picked from commit 223a359f21)
2022-06-02 20:04:06 +02:00
Zbigniew Jędrzejewski-Szmek
0d3ba825e2 man/systemd.automount: move the main description up and clarify deps
(cherry picked from commit 93dbc22a95)
2022-06-02 20:04:06 +02:00
Eduard Tolosa
d5be915999 loader.conf: Clarify the default value of timeout.
(cherry picked from commit 815068d3a3)
2022-06-02 20:04:06 +02:00
Rahil Bhimjiani
4bd2056fbc [sd-boot] improve documentation of beep
(cherry picked from commit 97e7d4945d)
2022-06-02 20:04:06 +02:00
Zbigniew Jędrzejewski-Szmek
f2f40edcb9 man: fix typo 2022-05-16 14:54:43 +02:00
Zbigniew Jędrzejewski-Szmek
7353de27b7 man,mkosi: fedora 36 has been released 2022-05-13 02:34:07 +09:00
Luca Boccassi
0cfb00d9da man: improve VtableExample
The methods published by the example have a reply in the signature, but
the code was not sending any, so the client gets stuck waiting for a
response that doesn't arrive. Echo back the input string.

Update the object path to follow what would be the canonical format.

Request a service name on the bus, so that the code can be dropped in a
service and it can be dbus-activatable. It also makes it easier to see
on busctl list.
2022-05-11 19:12:24 +01:00
Kazuo Moriwaka
4da5e566e7
man: mention to Age parameter in C Type 2022-05-11 15:08:34 +09:00
Kazuo Moriwaka
6f310287db
add missing cleanup-age to quickref 2022-05-10 17:41:21 +09:00
Frantisek Sumsal
624f685fe8 core: annotate Reexecute() as NoReply
So we're able to tell from the introspection data that the method
doesn't reply.
2022-05-10 14:16:11 +09:00
Yu Watanabe
3c60643848 man: fix typo 2022-05-07 15:17:56 +09:00
Yu Watanabe
87d3b4ef3b
Merge pull request #23292 from alexhenrie/dhcpv6
network: clarify relationship between RA flags and DHCPv6 modes
2022-05-07 11:42:45 +09:00
Alex Henrie
6e40d0e458 network: clarify the relationship between DHCP= and WithoutRA=
Just setting DHCP=ipv6 is not enough to get DHCPv6 working without RA.
The WithoutRA option must also be changed from its default of "no".
2022-05-06 14:01:53 -06:00
Alex Henrie
0bcc6557fb network: clarify the relationship between RA flags and DHCPv6 modes
In the documentation, using the term "managed" for both the RA flag and
the DHCPv6 mode is confusing because the mode is referred to as
"solicit" both in the official DHCPv6 documentation (see RFC 8415) and
in the WithoutRA option.

Furthermore, calling the other RA flag "other information" or "other
address configuration" is confusing because its official name is simply
"other configuration" (see RFC 4861 and RFC 5175) and it isn't used to
assign IP addresses.

Rewrite the documentation for DHCPv6Client and WithoutRA to make it
clear that getting the "managed" RA flag triggers the same kind of DHCP
request as WithoutRA=solicit, whereas getting the "other configuration"
RA flag triggers the same kind of DHCP request as
WithoutRA=information-request.
2022-05-06 14:01:53 -06:00
Yu Watanabe
af2ff171e0
Merge pull request #23272 from keszybz/logind-man-and-rules
Logind man and rules
2022-05-07 04:23:02 +09:00
Jakob Lell
14736ab6ff Amend documentation for LimitNPROC= 2022-05-05 18:04:54 +02:00
Zbigniew Jędrzejewski-Szmek
14e6e444dd bootctl: add --quiet
It's useful for installation scripts and suchlike.
Raised in https://bugzilla.redhat.com/show_bug.cgi?id=2079784#c9.
2022-05-05 12:30:06 +02:00
Zbigniew Jędrzejewski-Szmek
18eb56c3c0 bootctl: support --graceful in is-installed 2022-05-05 12:30:06 +02:00
Zbigniew Jędrzejewski-Szmek
e4239a34d7 man: deduplicate dbus versioning ref 2022-05-05 11:48:22 +02:00
Zbigniew Jędrzejewski-Szmek
01942823ae man: beef up o.fd.login1 page a bit and recommend busctl too
gdbus is an external program, so it makes sense to recommend busctl.
2022-05-05 11:48:22 +02:00