1
0
mirror of https://github.com/systemd/systemd.git synced 2024-12-28 11:21:59 +03:00
Commit Graph

2121 Commits

Author SHA1 Message Date
Susant Sahani
0371f2df67 man: netdev add man for macvtap 2015-07-27 11:19:08 +05:30
Tom Gundersen
eeb4b73b6a Merge pull request #727 from phomes/master
man: typo fixes
2015-07-25 23:27:44 +02:00
Thomas Hindoe Paaboel Andersen
dd2b607b7d man: typo fixes 2015-07-25 23:15:51 +02:00
Zbigniew Jędrzejewski-Szmek
57e27ec0ad man: describe masking of .network files better
This should clear up some confusion in
https://github.com/systemd/systemd/issues/717.

This basically copies the description from systemd.unit to this
man page. Masking can happen also in /run, so strike the part
about /etc, and also add the magic work "mask".
2015-07-25 13:08:21 -04:00
Zbigniew Jędrzejewski-Szmek
23da66bb40 networkd: rename RootBlock to AllowPortToBeRoot
Justification is similar to BPDUGuard rename. "Positive" values
are easier. This is a rather uncommon option, so using a slightly
longer name should not be a problem, and may in fact may make it
easier to guess what the option does without reading the
documentation.
2015-07-24 23:44:42 -04:00
Zbigniew Jędrzejewski-Szmek
072f9e4af4 networkd: turn UnicastFlood on by default
Looking at the kernel commit, "on" seems to be the default value:
commit 867a59436fc35593ae0e0efcd56cc6d2f8506586
Author: Vlad Yasevich <vyasevic@redhat.com>
Date:   Wed Jun 5 10:08:01 2013 -0400

    bridge: Add a flag to control unicast packet flood.

    Add a flag to control flood of unicast traffic.  By default, flood is
    on and the bridge will flood unicast traffic if it doesn't know
    the destination.  When the flag is turned off, unicast traffic
    without an FDB will not be forwarded to the specified port.

... and it seems to be the reasonable thing to do by default.
2015-07-24 23:44:42 -04:00
Zbigniew Jędrzejewski-Szmek
84c3409631 networkd: rename BPDUGuard to UseBPDU
Rename to follow the follow the style of other options.

In general "positive" options are preferred to "negative" ones,
because they are easier to describe and easier for humans to
parse (c.f. the shortening on the man page entry).
2015-07-24 23:44:42 -04:00
Zbigniew Jędrzejewski-Szmek
47c7dfe275 man: reword new Bridge descriptions 2015-07-24 23:44:42 -04:00
Zbigniew Jędrzejewski-Szmek
a9b70f9dfd network: rename DiffServiceCodePoint to CopyDSCP
Old name was slightly misleading, because this flag does not determine
whether DSCP is used overall, but only if it is copied to the
decapsulated packet. Rename to better reflect that.

"Copy" does not imply direction. This is on purpose, because we might
later on enhance the setting to allow/disallow copying in the other
direction, to the encapsulated packet. If that is implemented,
CopyDSCP could understand additional values. This is nicer than
having two separate settings and follows the example of DHCP=.

Also, we try to avoid abbreviations, but we allow acronyms
like MTU, in DiscoverPathMTU=.

This setting was recently added, so it's fine to rename it without
backwards compat.
2015-07-24 23:44:34 -04:00
Zbigniew Jędrzejewski-Szmek
3cf4bcab07 man: try to better describe DiffServiceCodePoint= setting
http://marc.info/?l=linux-netdev&m=109507453227993&w=2
2015-07-24 23:43:51 -04:00
Zbigniew Jędrzejewski-Szmek
d59be2cf70 man: reword description of Hostname=
Also add dots at the end of sentences.
2015-07-24 23:43:51 -04:00
Susant Sahani
165c41a99a man: add man for bridge params 2015-07-23 23:33:40 +05:30
Daniel Mack
56511eca83 Merge pull request #674 from ssahani/tunnel
ip6 tunnel: add support for DSCP
2015-07-23 11:00:15 +02:00
Susant Sahani
9b0ca30a91 man: add man for DSCP 2015-07-23 13:38:26 +05:30
David Herrmann
8cd4eb791a Merge pull request #537 from poettering/nss-mymachines-userns
Hook up container userns with nss-mymachines
2015-07-23 09:53:47 +02:00
Susant Sahani
276de52699 man: add man ipv6 flowlabel support for ip6 tunnels 2015-07-21 10:07:10 +05:30
Tom Gundersen
31053e929e Merge pull request #549 from ssahani/dhcp
networkd: allow hostname override
2015-07-20 17:58:45 +02:00
Vivenzio Pagliari
9e0d90f99d Typo fix in systemd.preset manpage 2015-07-17 15:02:26 +02:00
Susant Sahani
43f78da4ed man: add man for tap vnet_hdr 2015-07-14 20:48:09 +05:30
Johan Ouwerkerk
d77c25b116 doc: configure docbook stylesheet to generate reproducible IDs
This makes auto generated anchor tags in HTML output reproducible.
2015-07-13 16:30:30 +02:00
Daniel Mack
9e400131f7 Merge pull request #561 from cmacq2/html-man-fixes
Html man fixes
2015-07-12 11:33:27 -04:00
Johan Ouwerkerk
aa1169774b Use a top-to-bottom numbering scheme for generating ids of subheadings and terms.
This scheme fixes permalinks to distinguish between items that would previously have the same ID attribute.

Where possible the generated ID values are the same as those generated with the previous versions of the stylesheet
to retain backwards compatibility with published links.

As a side effect of the changes xsltproc should no longer complain about duplicate IDs during build.
2015-07-12 08:30:07 +02:00
Lennart Poettering
b898f9bd7e man: go further into details regarding life-cycle of default bus connection objects
This extends on PR #542.
2015-07-11 16:11:45 -03:00
Susant Sahani
1adc5d0bcd man: add manual for DHCP override hostname 2015-07-11 09:26:55 +05:30
Umut Tezduyar Lindskog
db03761e16 man: sd_unref does not necessarily free the bus
Document that sd_unref() does not necessarily free the bus,
even if no part of the program explicitly refs it, due to
the queued messages.
2015-07-10 14:32:02 +02:00
Lennart Poettering
c01ff965b4 nss-mymachines: map userns users of containers to real user names
Given a container "foo", that maps user id $UID to container user, using
user namespaces, this NSS module extenstion will now map the $UID to a
name "vu-foo-$TUID" for the translated UID $UID.

Similar, userns groups are mapped to "vg-foo-$TGID" for translated GIDs
of $GID.

This simple change should make userns users more discoverable. Also,
given that many tools like "adduser" check NSS before allocating a UID,
should lower the chance of UID range conflicts between tools.
2015-07-09 14:46:20 -03:00
Lennart Poettering
380aea0c5b Merge pull request #520 from zonque/pr-384-rework
man-pages: PR 384 rework
2015-07-08 16:50:48 -03:00
Lennart Poettering
2a2e6a0845 man: minor updates to the sd_bus_request_name() documentation 2015-07-08 13:53:42 -04:00
Lennart Poettering
dddbc69577 man: document user slice sd-login calls we added a while back 2015-07-08 13:53:42 -04:00
Lennart Poettering
0285564349 man: fix sd_bus_negotiate_timestamps documentation link-up 2015-07-08 13:53:42 -04:00
Lennart Poettering
f6f7a9848e man: fully document sd_bus_creds subsystem
[@zonque: typo fixed, reported by @ronnychevalier]
2015-07-08 13:53:15 -04:00
Lennart Poettering
9d3e5d11be man: fully document sd-bus' error APIs
[@zonque: Some minor nits fixed as pointed out by @ronnychevalier,
 dropped class='sd-bus-errors' to fix python logic]
2015-07-08 13:51:39 -04:00
Daniel Mack
1ad9e2f89c Merge pull request #519 from poettering/man-bus-message-append
man: update and extend the various sd_bus_message_append_*() man pages
2015-07-08 12:17:47 -04:00
Lennart Poettering
e8216945a9 man: update and extend the various sd_bus_message_append_*() man pages
Some calls changed their signature since the man pages were written.
Also extend on a number of details.
2015-07-07 20:35:45 +02:00
Zbigniew Jędrzejewski-Szmek
2799e519ca Remove python-systemd
python-system has moved to it's own repository:
https://github.com/systemd/python-systemd
2015-07-06 20:32:12 -04:00
Daniel Mack
5b7a135265 Merge pull request #497 from phomes/master
man: sd-bus: typo fix
2015-07-06 14:45:50 -04:00
Thomas Hindoe Paaboel Andersen
67ad70e4e9 man: sd-bus: typo fix 2015-07-06 20:37:32 +02:00
Lennart Poettering
1f0d969512 networkd: various fixes for the IPv6 privacy extensions support
- Make sure that the IPv6PrivacyExtensions=yes results in
  prefer-temporary, not prefer-public.

- Introduce special enum value "kernel" to leave setting unset, similar
  how we have it for the IP forwarding settings.

- Bring the enum values in sync with the the strings we parse for them,
  to the level this makes sense (specifically, rename "disabled" to
  "no", and "prefer-temporary" to "yes").

- Make sure we really set the value to to "no" by default, the way it is
  already documented in the man page.

- Fix whitespace error.

- Make sure link_ipv6_privacy_extensions() actually returns the correct
  enum type, rather than implicitly casting it to "bool".

- properly size formatting buffer for ipv6 sysctl value

- Don't complain if /proc/sys isn't writable

- Document that the enum follows the kernel's own values (0 = off, 1 =
  prefer-public, 2 = prefer-temporary)

- Drop redundant negating of error code passed to log_syntax()

- Manpage fixes

This fixes a number of issues from PR #417
2015-07-06 20:37:22 +02:00
Daniel Mack
b5070ab9d0 Merge pull request #417 from ssahani/ipv6-private
Ipv6 private extensions
2015-07-05 13:08:13 -04:00
Susant Sahani
a46e37cb12 man: add manual for ipv6 privacy extension 2015-07-05 11:25:20 +05:30
David Herrmann
e2bccc9d99 man: fix sysctl references in networkd-manpage
We refer to the same sysctl-setting twice, which is misleading. Correctly
list all global forwarding options. As we _always_ change the forwarding
setting on links, they will get disabled by default. The global sysctl
defaults thus will not have any effect.
2015-07-04 13:10:10 +02:00
Zbigniew Jędrzejewski-Szmek
92c4eaf76d Merge pull request #472 from keszybz/documentation-updates2
Documentation updates
2015-07-02 09:41:32 -04:00
Zbigniew Jędrzejewski-Szmek
9407bc2d03 man: update sysctl example about netfilter
It turns out that since kernel 3.18 netfilter on bridged packets
is off anyway, so the example should be reworded (and the module
name updated).
2015-07-02 09:15:09 -04:00
Zbigniew Jędrzejewski-Szmek
ea539eb659 man: information about available properties
https://bugzilla.redhat.com/show_bug.cgi?id=1144496
2015-07-02 09:15:09 -04:00
Daniel Mack
38b541c4f2 Merge pull request #419 from eworm-de/man-protecthome
man: ProtectHome= protects /root as well
2015-07-01 13:45:33 -04:00
Kay Sievers
f2b8052fb6 udev: remove WAIT_FOR key
This facility was never a proper solution, but only papered over
real bugs in the kernel. There are no known sysfs "timing bugs"
since a long time.
2015-06-30 19:57:40 +02:00
Christian Hesse
5833143708 man: ProtectHome= protects /root as well 2015-06-30 19:12:20 +02:00
Jay Strict
1d3eaa9361 man: remove repeated word "the" and polish 2015-06-29 21:20:02 +02:00
Andrew Eikum
853382da70 man: Remove instances of pseudo-English "resp."
Me again :) Just noticed one of these in a manpage and did another pass
to clean them up.  See 16dad32e43 for
explanation, though the link needs updating:
<http://transblawg.eu/2004/02/26/resp-and-other-non-existent-english-wordsnicht-existente-englische-worter/>
2015-06-29 10:33:31 -05:00
Felipe Sateler
341db20b7e systemd.service.xml: document that systemd removes the PIDFile 2015-06-27 17:25:06 -03:00
Michael Biebl
e6de49abfd man: install networkctl and sysusers.d man page conditionally 2015-06-23 10:40:29 +02:00
Kay Sievers
1f35347af0 man: remove stray · from header 2015-06-22 19:54:52 +02:00
Kay Sievers
b8332e7abb man: remove links to outdated kdbus development repository 2015-06-22 19:54:09 +02:00
Markus Knetschke
cb7bb815d2 fix machinectl bind man entry 2015-06-20 17:05:48 +02:00
Daniel Mack
faebe5a933 man: rename systemd-bus-proxyd@.service.xml → systemd-bus-proxyd.service.xml
The bus proxy is multi-threaded now. Reflect that in the man pages.
2015-06-20 14:28:50 +02:00
daurnimator
30cd76383a man: sd-bus: it's 'machine' not 'container' 2015-06-20 18:57:53 +10:00
Lennart Poettering
3ed18ce28c man: be more careful with the wording in busctl(1) 2015-06-19 22:29:29 +02:00
Lennart Poettering
850df10ac1 man: various documentation improvements for sd-bus 2015-06-19 22:19:02 +02:00
Kay Sievers
6433d44072 Merge pull request #293 from teg/man-revert
man: revert dynamic paths for split-usr setups
2015-06-18 22:27:50 +02:00
Tom Gundersen
12b42c7667 man: revert dynamic paths for split-usr setups
This did not really work out as we had hoped. Trying to do this upstream
introduced several problems that probably makes it better suited as a
downstream patch after all. At any rate, it is not releaseable in the
current state, so we at least need to revert this before the release.

 * by adjusting the path to binaries, but not do the same thing to the
   search path we end up with inconsistent man-pages. Adjusting the search
   path too would be quite messy, and it is not at all obvious that this is
   worth the effort, but at any rate it would have to be done before we
   could ship this.

 * this means that distributed man-pages does not make sense as they depend
   on config options, and for better or worse we are still distributing
   man pages, so that is something that definitely needs sorting out before
   we could ship with this patch.

 * we have long held that split-usr is only minimally supported in order
   to boot, and something we hope will eventually go away. So before we start
   adding even more magic/effort in order to make this work nicely, we should
   probably question if it makes sense at all.
2015-06-18 19:47:44 +02:00
Tom Gundersen
2ef24a16ac man: udev_device - finish new_* man page
A description of device_id lacked. We still need to do the other
udev_device_* man pages.
2015-06-18 19:18:33 +02:00
Kay Sievers
b34503a7fd Merge pull request #269 from teg/udev-docs-1
man: libudev - add description to udev_device_*
2015-06-18 00:45:51 +02:00
Lennart Poettering
7128df76f0 man: minor typo fix 2015-06-17 23:50:13 +02:00
Tom Gundersen
00dbd902e9 man: libudev - add description to udev_device_* 2015-06-17 19:48:15 +02:00
Kay Sievers
1b09f548c7 turn kdbus support into a runtime option
./configure --enable/disable-kdbus can be used to set the default
behavior regarding kdbus.

If no kdbus kernel support is available, dbus-dameon will be used.

With --enable-kdbus, the kernel command line option "kdbus=0" can
be used to disable kdbus.

With --disable-kdbus, the kernel command line option "kdbus=1" is
required to enable kdbus support.
2015-06-17 18:01:49 +02:00
Lennart Poettering
eef8c1f6fd Merge pull request #221 from utezduyar/man-cgtop-explain-max-cpu
man: explain max CPU load on cgtop
2015-06-17 15:48:31 +02:00
David Herrmann
06255d6f76 man: add libudev man-pages (skeletons)
This adds man-pages for most of the libudev symbols we export. Similar
symbols are grouped together in a single man-page, with respective links
added. All man-pages contain the full skeleton including NAME, SYNOPSIS,
RETURN VALUE and SEE ALSO. However, most of them still lack the
DESCRIPTION part. This should be copied from the gtkdoc descriptions in
src/libudev/libudev*.[ch]. Any help is welcome! (the whole skeleton is
already done, so it's really just about the prose-part of the man-pages to
be written).

Missing from the man-pages are the following parts:
  - udev_set_log_fn()
  - udev_[gs]et_log_priority()
  - udev_[gs]et_userdata()
  - udev_list_entry_foreach()
  - udev_device_get_seqnum()
  - udev_device_get_usec_since_initialized()
  - udev_util_encode_string()
These are considered legacy, afaik. If not, please feel free to add them
now!

Furthermore, udev-hwdb and udev-queue are not documented at all (for the
same reasons).
2015-06-17 15:22:49 +02:00
Umut Tezduyar Lindskog
b0f5a5105b man: explain max CPU load on cgtop 2015-06-17 13:30:26 +02:00
Lennart Poettering
48f69d8fb4 man: always build sd-bus man pages, even if kdbus is disabled
After all, we now moved sd-bus out of the kdbus conditional, hence the
man pages should be too.
2015-06-17 12:32:33 +02:00
Jan Synacek
b6872d3abe doc: improve readability in journald.conf.5 2015-06-17 10:12:09 +02:00
Lennart Poettering
cceb20c75c man: document that ExecStop= needs a synchronous tool
As requested in #199.
2015-06-15 12:06:02 +02:00
Lennart Poettering
e8c5393631 man: document that SIGCONT always follows SIGTERM
As requested in #199.
2015-06-15 12:05:57 +02:00
Lennart Poettering
c6355b313e man: clarify overriding semantics of systemd-gpt-auto-generator
Specifically: /etc/fstab overrides the units itself, but not the deps.

See #168.
2015-06-15 11:49:26 +02:00
Igor Vuk
e26cb3b79a Fix typos in man/timesyncd.conf.xml 2015-06-14 18:28:55 +02:00
David Herrmann
01856799a3 man: don't mention '/run' in hwdb.man
We do not support '/run' for hwdb files. Drop it from the man-pages so
people don't accidentally use it.

This was reported by: Peter Hutterer <peter.hutterer@who-t.net>
2015-06-14 14:26:31 +02:00
David Herrmann
e7f25cf7d9 Merge pull request #178 from utezduyar/man-sd_bus_message_get_creds
Improve the documentation of bus credentials by mentioning send-time metadata. This needs more love, we should really clarify metadata details here. However, this is still better than nothing, so it's fine.
2015-06-14 13:22:44 +02:00
Umut Tezduyar Lindskog
b655a0282c man: mention sd_bus_message_get_creds as another way
of retrieving sd_bus_creds even though sd_bus_creds itself
contains very limited information.
2015-06-12 14:33:52 +02:00
Lennart Poettering
533b432940 Merge pull request #173 from mischief/ipforwarding-3
IPForwarding=kernel v3
2015-06-12 12:28:16 +02:00
Nick Owens
2972cba117 man: document IPForward=kernel option 2015-06-11 12:09:27 -07:00
Lennart Poettering
37c47e5e5b Merge pull request #3 from threatgrid/more_cgtop_enhancements
cgtop enhancements for easier machine-readable output
2015-06-11 01:52:25 +02:00
Andrei Borzenkov
9de4d0ce2d man: clarify that IMPORT{program} is done only for zero exit code 2015-06-10 19:43:36 +03:00
Tom Gundersen
87aeefc31e man: udevd - correct default event timeout
This was changed from 30 to 180 seconds quite some time ago.
2015-06-10 15:59:30 +02:00
Charles Duffy
780fe62eca cgtop: allow user to force looping behavior even in non-TTY mode 2015-06-09 19:39:16 -05:00
Charles Duffy
a2c9f63136 cgtop: raw output option (disable conversion to human-readable units) 2015-06-09 19:39:16 -05:00
Lennart Poettering
ee0eb1d891 Revert "networkd: create "kernel" setting for IPForwarding" 2015-06-08 23:24:32 +02:00
Tom Gundersen
2e229e0c4c man: systemd.link - explain random MAC addresses
Two of the bits in the MAC address are set unconditioanlly, and the rest is randomized,
make this clear in the documentation (as it currently read as if it was all random).
2015-06-08 22:30:59 +02:00
Michael Biebl
9391a1c3d6 systemctl: Use /usr/bin/editor if available
If the EDITOR environment variable is not set, the Debian policy
recommends to use the /usr/bin/editor program as default editor.
This file is managed via the dpkg alternatives mechanism and typically
used in Debian/Ubuntu and derivatives to configure the default editor.

See section 11.4 of the Debian policy [1].

Therefor prefer /usr/bin/editor over specific editors if available.

[1] https://www.debian.org/doc/debian-policy/ch-customized-programs.html
2015-06-03 14:14:42 +02:00
Tom Gundersen
cfe907ab6e Merge pull request #41 from mischief/ipforwarding
networkd: create "kernel" setting for IPForwarding
2015-06-03 01:02:51 +02:00
Nick Owens
3ed7e9c735 man: document IPForward=kernel option 2015-06-02 15:42:21 -07:00
Kay Sievers
2375607039 remove gudev and gtk-doc
The library moved to:
  https://git.gnome.org/browse/libgudev/
2015-06-03 00:22:53 +02:00
Daniel Mack
7d2e33a416 man: replace hard-coded /usr/lib
Replace some /usr/lib occurences in man/ with &rootprefix;/lib.
2015-06-02 07:54:51 -07:00
Filipe Brandenburger
d31dd62ba2 man: use configured path for mount and umount binaries in manpages
Export the MOUNT_PATH and UMOUNT_PATH variables as XML entities and use them in
the systemctl.1 manpage instead of hardcoding the path in /usr/bin.

Tested:
- Ran ./configure ac_cv_path_MOUNT_PATH=/bin/mount (same for umount) and
  rebuilt the manpages, confirmed that the correct path was in man/systemctl.1
- Rebuilt man/systemd.directives.xml and the man pages derived from it,
  confirmed that the correct paths were there as well.
2015-05-28 19:28:23 +02:00
Filipe Brandenburger
681eb9cf2b man: generate configured paths in manpages
In particular, use /lib/systemd instead of /usr/lib/systemd in distributions
like Debian which still have not adopted a /usr merge setup.

Use XML entities from man/custom-entities.ent to replace configured paths while
doing XSLT processing of the original XML files. There was precedent of some
files (such as systemd.generator.xml) which were already using this approach.

This addresses most of the (manual) fixes from this patch:
http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/patches/Fix-paths-in-man-pages.patch?h=experimental-220

The idea of using generic XML entities was presented here:
http://lists.freedesktop.org/archives/systemd-devel/2015-May/032240.html

This patch solves almost all the issues, with the exception of:
- Path to /bin/mount and /bin/umount.
- Generic statements about preference of /lib over /etc.

These will be handled separately by follow up patches.

Tested:
- With default configure settings, ran "make install" to two separate
  directories and compared the output to confirm they matched exactly.
- Used a set of configure flags including $CONFFLAGS from Debian:
  http://anonscm.debian.org/cgit/pkg-systemd/systemd.git/tree/debian/rules
  Installed the tree and confirmed the paths use /lib/systemd instead of
  /usr/lib/systemd and that no other unexpected differences exist.
- Confirmed that `make distcheck` still passes.
2015-05-28 19:28:19 +02:00
Patrick Donnelly
c4e87748d5 man: fix systemd.resource-control(5) volume number 2015-05-27 23:37:19 +02:00
Torstein Husebø
45afd51974 treewide: fix typos 2015-05-26 19:55:51 +02:00
Karel Zak
bf1d7ba70a swap: use swapon -o
This patch simplify swapon usage in systemd. The command swapon(8)
since util-linux v2.26 supports "-o <list>". The idea is exactly the
same like for mount(8). The -o specifies options in fstab-compatible
way. For systemd it means that it does not have to care about things
like "discard" or another swapon specific options.

        swapon -o <options-from-fstab>

For backward compatibility the code cares about "Priority:" swap unit
field (for a case when Priority: is set, but pri= in the Options: is
missing).

References: http://lists.freedesktop.org/archives/systemd-devel/2014-October/023576.html
2015-05-25 17:06:15 +02:00
Jonathan Boulle
7c918141ed fix typos in systemd-nspawn man page 2015-05-23 10:41:00 +02:00
Lennart Poettering
03cfe0d514 nspawn: finish user namespace support 2015-05-21 16:32:01 +02:00
Martin Pitt
139e533628 hostname: Allow comments in /etc/hostname
The hostname(1) tool allows comments in /etc/hostname. Introduce a new
read_hostname_config() in hostname-util which reads a hostname configuration
file like /etc/hostname, strips out comments, whitespace, and cleans the
hostname. Use it in hostname-setup.c and hostnamed and remove duplicated code.

Update hostname manpage. Add tests.

https://launchpad.net/bugs/1053048
2015-05-19 12:18:08 +02:00
Zbigniew Jędrzejewski-Szmek
e88d8021ba man: explain UseDomains a bit more
https://bugs.freedesktop.org/show_bug.cgi?id=85397
2015-05-18 22:35:42 -04:00