Commit Graph

281 Commits

Author SHA1 Message Date
Zbigniew Jędrzejewski-Szmek 909f413d3c man: always supply quotes around literals
When manpages are displayed on a terminal, <literal>s are indistinguishable
from surrounding text. Add quotes everywhere, remove duplicate quotes,
and tweak a few lists for consistent formatting.

https://bugzilla.redhat.com/show_bug.cgi?id=874631
2013-06-26 08:05:14 -04:00
Ville Skyttä d2bbca6855 Spelling fixes 2013-05-03 22:45:09 -04:00
Zbigniew Jędrzejewski-Szmek a827e37371 man: clarify what Restart= means
Related to https://bugzilla.redhat.com/show_bug.cgi?id=957135.
2013-04-29 19:52:30 -04:00
Zbigniew Jędrzejewski-Szmek 4c42e8e161 man/service: document behaviour on failure
https://bugs.freedesktop.org/show_bug.cgi?id=38355
2013-03-19 22:15:01 -04:00
Zbigniew Jędrzejewski-Szmek df34f169b8 man: fix grammar 2013-03-15 22:55:24 -04:00
Mathieu Bridon 3ae390ba02 man: Document the actual behaviour of ExecStopPost
The documentation makes it sound like ExecStopPost is only run when
stopping the service with `systemctl stop foo.service`

However, that is not the case, as it also gets run when the service
unexpectedly exists, crashes, or gets SIGKILLed.
2013-03-13 00:51:35 -04:00
Max F. Albrecht 22382c3f57 man: be even more clear about ExecStart's first argument. 2013-02-20 13:49:57 -08:00
Zbigniew Jędrzejewski-Szmek e670b166a0 man: use <replaceable> in various places 2013-02-13 23:09:00 -05:00
Zbigniew Jędrzejewski-Szmek ccc9a4f9ff man: extend systemd.directives(7) to all manual pages
New sections are added: PAM options, crypttab options, commandline
options, miscellaneous. The last category will be used for all
untagged <varname> elements.

Commandline options sections is meant to be a developer tool: when
adding an option it is sometimes useful to be able to check if
similarly named options exist elsewhere.
2013-01-26 11:36:53 -05:00
Eelco Dolstra 2813720202 Fix some typos 2013-01-22 10:03:16 -05:00
Lennart Poettering 74051b9b58 units: for all unit settings that take lists, allow the empty string for resetting the lists
https://bugzilla.redhat.com/show_bug.cgi?id=756787
2013-01-17 02:50:05 +01:00
Zbigniew Jędrzejewski-Szmek 9cc2c8b763 man: add links to directive index to see-alsos
systemd.directives(5) is renamed to systemd.directives(7).
Section 7 is "Miscellaneous".
2013-01-15 11:30:42 -05:00
Lennart Poettering 22f38abe9a man: clarify that specifiers cannot be used in ExecStart='s first argument 2013-01-03 22:37:31 +01:00
Zbigniew Jędrzejewski-Szmek 2480f0c677 man: update description of ExecStart and friends
Semicolon separated lines are supported for all those commands,
and semicolons can now be escaped.
2012-11-15 16:01:22 +01:00
Zbigniew Jędrzejewski-Szmek 0f67f1efae core: lift restriction on order of - and @ in ExecStart 2012-11-15 16:01:22 +01:00
Thomas Hindoe Paaboel Andersen bb31a4ac19 man: typo fixes
https://bugs.freedesktop.org/show_bug.cgi?id=55890

Fixed typos, serial comma, and removed "either" as there were more
than two options. Also did an extra rename of "system-shutdown"
to "systemd-shutdown" that was forgotten in commit
8bd3b8620c
2012-10-26 00:16:47 +02:00
Lennart Poettering 97ae63e2a9 service: when invoking service processes in --user mode set MANAGERPID to PID of systemd 2012-10-18 01:18:50 +02:00
Andrew Eikum 16dad32e43 Reword sentences that contain psuedo-English "resp."
As you likely know, Arch Linux is in the process of moving to systemd.
So I was reading through the various systemd docs and quickly became
baffled by this new abbreviation "resp.", which I've never seen before
in my English-mother-tongue life.

Some quick Googling turned up a reference:
<http://www.transblawg.eu/index.php?/archives/870-Resp.-and-other-non-existent-English-wordsNicht-existente-englische-Woerter.html>

I guess it's a literal translation of the German "Beziehungsweise", but
English doesn't work the same way. The word "respectively" is used
exclusively to provide an ordering connection between two lists. E.g.
"the prefixes k, M, and G refer to kilo-, mega-, and giga-,
respectively." It is also never abbreviated to "resp." So the sentence
"Sets the default output resp. error output for all services and
sockets" makes no sense to a natural English speaker.

This patch removes all instances of "resp." in the man pages and
replaces them with sentences which are much more clear and, hopefully,
grammatically valid. In almost all instances, it was simply replacing
"resp." with "or," which the original author (Lennart?) could probably
just do in the future.

The only other instances of "resp." are in the src/ subtree, which I
don't feel privileged to correct.

Signed-off-by: Andrew Eikum <aeikum@codeweavers.com>
2012-10-16 01:03:01 +02:00
Thomas Hindoe Paaboel Andersen c53158818d man: fix a bunch of typos in docs
https://bugs.freedesktop.org/show_bug.cgi?id=54501
2012-09-13 19:34:24 +02:00
Lennart Poettering a29271926a man: document that ExecStart= doesn't understand shell command lines 2012-09-05 23:51:19 -07:00
Lennart Poettering abdf799316 man: extend documentation for RestartPreventExitStatus= and SuccessExitStatus= a bit 2012-08-14 18:37:45 +02:00
Lukas Nykryn 96342de68d service: add options RestartPreventExitStatus and SuccessExitStatus
In some cases, like wrong configuration, restarting after error
does not help, so administrator can specify statuses by RestartPreventExitStatus
which will not cause restart of a service.

Sometimes you have non-standart exit status, so this can be specified
by SuccessfulExitStatus.
2012-08-14 14:46:03 +02:00
Michal Sekletar d568a3350e systemd: introduced new timeout types
Makes possible to specify separate timeout for start and stop of
the service.

[ Improved the manpage. Coding style fix. -- michich ]
2012-08-08 18:11:09 +02:00
Lennart Poettering 4819ff0358 unit: split off KillContext from ExecContext containing only kill definitions 2012-07-20 00:10:31 +02:00
Lennart Poettering 34511ca7b1 man: reword man page titles
Make sure the man page titles are similar in style and capitalization so
that our man page index looks pretty.
2012-07-16 18:08:25 +02:00
Lennart Poettering 5389fedd99 man: document Restart= a bit more 2012-07-04 00:37:12 +02:00
Lennart Poettering 451b34cc1d service: flush the start counter in "systemctl reset-failed" 2012-07-04 00:23:42 +02:00
Lennart Poettering 6ffd333786 man: clarify that StartLimitInterval= also applies to manual starts 2012-07-04 00:12:13 +02:00
Lennart Poettering f1c8f75b38 man: explain StartLimitRate= in conjunction with Restart= a bit better 2012-07-04 00:07:33 +02:00
Lennart Poettering 9980033377 man: add various links from man pages to appropriate wiki pages 2012-06-28 18:58:56 +02:00
Lennart Poettering dac051ad68 man: extend watchdog docs a bit 2012-06-28 00:24:49 +02:00
Lukas Nykryn 98709151f3 service: timeout for oneshot services
Add possibility to specify timeout for oneshot services.

[ https://bugzilla.redhat.com/show_bug.cgi?id=761656
  Added minor fixups. -- michich ]
2012-06-15 16:04:06 +02:00
Lennart Poettering c485d3ba09 service: mark compat options as such
This moves FsckPassNo= and SysVStartPriority= into its own
"Compatibility Options" section in the man page to clarify that these
options are not useful for anything but establishing a limited amount of
compatibility.

Also stop exposing these options on the bus.
2012-05-30 21:42:07 +02:00
Lennart Poettering 66b1a24790 man: properly document FsckPassNo= for mount units 2012-05-23 04:11:29 +02:00
Lennart Poettering 3614084261 service: make the fsck pass no configurable 2012-05-21 17:24:26 +02:00
Lennart Poettering 0b86feac50 service: default to Type=dbus if BusName= is specified 2012-05-03 14:46:29 +02:00
Kay Sievers 349b915de5 man: fix typo 2012-04-30 15:30:57 +02:00
Lennart Poettering a8ad0f8928 service: document new Type=idle 2012-04-30 10:52:07 +02:00
Lennart Poettering 5430f7f2bc relicense to LGPLv2.1 (with exceptions)
We finally got the OK from all contributors with non-trivial commits to
relicense systemd from GPL2+ to LGPL2.1+.

Some udev bits continue to be GPL2+ for now, but we are looking into
relicensing them too, to allow free copy/paste of all code within
systemd.

The bits that used to be MIT continue to be MIT.

The big benefit of the relicensing is that closed source code may now
link against libsystemd-login.so and friends.
2012-04-12 00:24:39 +02:00
Lennart Poettering 02c4ef9c35 service: imply NotifyAccess=main if WatchdogSec= is used 2012-02-09 21:11:25 +01:00
Lennart Poettering 092317d034 man: document restart options 2012-02-09 21:01:29 +01:00
Lennart Poettering 2707271e8e man: fix XML
Spotted by Sergey Ptashnick.
2012-02-09 00:52:29 +01:00
Lennart Poettering e8ab3ccba4 man: document the WATCHDOG_USEC environment variable 2012-02-08 21:24:41 +01:00
Michael Olbrich bb242b7b52 service: introduce WatchdogSec and hook up the watchdog with the existing failure logic 2012-02-08 17:10:38 +01:00
Michal Schmidt 4f025f4c4f man: fix misplaced remark in description of Sockets= 2011-12-17 00:40:21 +01:00
Barry Scott 7734f77373 man: for ExecStart= provide more details on env var substitution and how that turns into arguments.
For EnvironmentFile= explain that double quotes can be used
to protect whitespace.
2011-10-11 01:11:26 +02:00
Lennart Poettering ecb963cc40 def: lower default timeout to 90s
Almost everybody found 3min too long, so lower it again
2011-04-27 22:30:50 +02:00
Lennart Poettering 05677bb780 man: fix specification of default timeouts 2011-04-20 00:51:23 +02:00
Lennart Poettering cd25cce98f exec: drop process group kill mode since it has little use and confuses the user 2011-03-29 23:31:38 +02:00
Lennart Poettering 177b3ffedb special: get rid of dbus.target 2011-03-18 04:53:12 +01:00
Lennart Poettering 3185a36b05 service: make main pid guessing optional, and reread pid file after reloads 2011-02-13 18:51:30 +01:00
Lennart Poettering be0396695b man: clarify a few things 2011-02-09 11:00:17 +01:00
Lennart Poettering ba035df230 execute: make sending of SIGKILL on shutdown optional 2011-01-18 22:55:54 +01:00
Lennart Poettering 2292707df5 man: document missing KillSignal= and swap options 2011-01-18 00:40:10 +01:00
Miklos Vajna 5471472d44 man: remaining spelling fixes 2011-01-01 20:03:56 +01:00
Andrew Edmunds f8553ccbb3 man: Fix various typos 2010-11-11 14:24:47 +01:00
Lennart Poettering 2ba545f1a0 service: implement FsckPassNo= option 2010-10-20 14:22:23 +02:00
Lennart Poettering 075b1e86c5 man: properly refer to $MAINPID instead of $(MAINPID) which doesnt work anymore 2010-10-19 19:37:38 +02:00
Lennart Poettering 50caaedb2c service: introduce Restart=on-failure and Restart=on-abort 2010-10-08 18:34:54 +02:00
Dave Reisner c899f8c61a fix typo: s/seperat/separat/g 2010-10-05 21:50:56 +02:00
Lennart Poettering a1102c1f63 man: fix typo 2010-10-05 21:22:41 +02:00
Lennart Poettering f72192c0c9 man: document Sockets= switch 2010-10-05 20:51:00 +02:00
Lennart Poettering 525ee6f4a1 service: rename settings for Restart= from 'restart-always' to 'always' and similar 2010-10-05 20:30:44 +02:00
Lennart Poettering d2f316345c man: document that first param to ExecStart= cannot be variable substitution
https://bugzilla.redhat.com/show_bug.cgi?id=630156
2010-09-15 01:44:26 +02:00
Michael Biebl 96d4ce0110 man: Fix small typo: s/seperate/separate/ 2010-09-06 03:13:14 +02:00
Lennart Poettering 02ee865a46 service: rename ValidNoProcess= to RemainAfterExit= 2010-08-17 19:37:36 +02:00
Lennart Poettering b1690fe70a man: document that we now accept more than one main process for Type=oneshot services 2010-08-13 18:46:04 +02:00
Lennart Poettering 34e9ba669e service: rename Type=finish to Type=oneshot and allow multiple ExecStart= lines for oneshot services
In contrast to the other service types oneshot services are usually not
long lasting and there's not necessarily a single clean main process for
them. This change allows multiple ExecStart= lines for this type of
services so that the admin/developer doesn't have to arbitrarily pick on
of various sequential commands as the "main one".
2010-08-13 18:23:01 +02:00
Lennart Poettering c24eb49e6a exec: extend variable substitution to support splitting variable values into seperate arguments 2010-07-21 02:57:35 +02:00
Lennart Poettering b708e7cea9 execute: optionally ignore return status of invoked commands 2010-07-12 03:07:01 +02:00
Lennart Poettering 420a0166a2 man: document variable substitution 2010-07-08 04:19:54 +02:00
Lennart Poettering b3eaa62881 man: update man pages for recent syntax changes 2010-07-07 21:22:56 +02:00
Lennart Poettering f3e219a238 update man pages for recent changes 2010-07-07 01:38:56 +02:00
Lennart Poettering 59a3e1bc46 man: more blurbs 2010-07-06 03:46:31 +02:00
Lennart Poettering 62adf224d1 man: various man page updates 2010-07-03 19:54:00 +02:00
Lennart Poettering ba60f9054e man: extend references to exec man page 2010-07-02 19:51:28 +02:00
Lennart Poettering 65232ea79d man: document automount units 2010-07-02 01:17:55 +02:00
Lennart Poettering 1f812feafb man: document socket units 2010-07-01 23:49:50 +02:00
Lennart Poettering 0d624a785a man: finish service man page 2010-07-01 19:39:35 +02:00
Kay Sievers af62c70405 man: various fixes 2010-06-25 00:04:29 +02:00
Lennart Poettering d1ab0ca073 man: add some initial man page work 2010-05-15 23:06:41 +02:00