summaryrefslogtreecommitdiff
path: root/man/systemd.automount.xml
Commit message (Collapse)AuthorAgeFilesLines
* man/automount: say that automounts should not be nestedZbigniew Jędrzejewski-Szmek2022-05-261-0/+4
| | | | Fixes #21832.
* man/systemd.automount: move the main description up and clarify depsZbigniew Jędrzejewski-Szmek2022-05-261-14/+10
|
* man: do not say "additional symlinks" for mount/automount aliasesZbigniew Jędrzejewski-Szmek2022-05-261-7/+7
| | | | | "additional" implies that the unit itself is a symlink, which it is not. Also "link to the mount unit", not "link to the mount".
* core/automount: Add ExtraOptions fieldAndrew Stone2021-11-231-0/+9
|
* man: mention pages with more settings at end of each option listZbigniew Jędrzejewski-Szmek2021-09-271-2/+8
| | | | | | | | | | | For some unit types we have hundreds of options, and the reader may easily miss that more options are described in other pages. We already mentioned this in the introduction and then at the top of the option list, but it can't hurt to repeat the information. Also, add an (almost empty) Options section for the unit types which don't have any custom options. It is nicer to have the same page structure in all cases, so people can jump between pages for different types more easily.
* man: document that automount units are privilegedLennart Poettering2020-12-091-0/+4
| | | | Fixes: #17886
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* tree-wide: drop quotes from around [section]Zbigniew Jędrzejewski-Szmek2020-07-061-3/+3
| | | | | | | For users, the square brackets already serve as markup and clearly delineate the section name from surrounding text. Putting additional markup around that only adds clutter. Also, we were very inconsistent in using the quotes. Let's just drop them altogether.
* doc: Try to clarify automount dependency confusionChris Down2020-06-091-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | Arch recently upgraded systemd to 245.6. Shortly afterwards, users began reporting[0] that systemd detected an ordering cycle, and they were unable to log in. The reason they were unable to log in was because of ordering cycle resolution: [...] systemd[1]: sysinit.target: Job systemd-tmpfiles-setup.service/start deleted to break ordering cycle starting with sysinit.target/start systemd[1]: sysinit.target: Job systemd-update-done.service/start deleted to break ordering cycle starting with sysinit.target/start systemd[1]: sysinit.target: Job systemd-journal-catalog-update.service/start deleted to break ordering cycle starting with sysinit.target/start systemd[1]: sysinit.target: Job local-fs.target/start deleted to break ordering cycle starting with sysinit.target/start systemd[1]: sysinit.target: Job systemd-tmpfiles-setup.service/start deleted to break ordering cycle starting with sysinit.target/start [...] Whether the resolution did the right thing here or not is a longer-term discussion, but in the interim we should at least make this distinction between automount dependencies and mount dependencies clearer in the documentation, so that users and distribution maintainers know what's acceptable. In this case Arch actually backed out b3d7aef5 entirely and released a new version due to the confusion. Also see https://github.com/systemd/systemd-stable/issues/69. 0: https://bugs.archlinux.org/task/66908
* automount: fix handling of default dependencies for automount unitsFranck Bui2020-04-091-0/+4
| | | | | | | | | | | First After=local-fs-pre.target wasn't described in the man page although it's part of the default dependencies automatically set by pid1. Secondly, Before=local-fs.target was only set if the automount unit was generated from the fstab-generator because the dep was explicitly generated. It was also not documented as a default dependency. Fix it by managing the dep from pid1 instead.
* man: change noindex="true" to index="false"Zbigniew Jędrzejewski-Szmek2019-11-211-1/+1
| | | | We nowadays prefer positive options over negative.
* man: Add missing <literal> tags in various man pagesPhilip Withnall2019-06-121-3/+3
| | | | | | | A minor formatting improvement brought to you by the wonders of `git grep`. Signed-off-by: Philip Withnall <withnall@endlessm.com>
* man: use same header for all filesZbigniew Jędrzejewski-Szmek2019-03-141-1/+1
| | | | | | | The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
* man: standarize on one-line license headerZbigniew Jędrzejewski-Szmek2019-03-141-4/+1
| | | | | | No need to waste space, and uniformity is good. $ perl -i -0pe 's|\n+<!--\s*SPDX-License-Identifier: LGPL-2.1..\s*-->|\n<!-- SPDX-License-Identifier: LGPL-2.1+ -->|gms' man/*.xml
* man: drop unused <authorgroup> tags from man sourcesZbigniew Jędrzejewski-Szmek2018-06-141-9/+0
| | | | | | | | | | | | Docbook styles required those to be present, even though the templates that we use did not show those names anywhere. But something changed semi-recently (I would suspect docbook templates, but there was only a minor version bump in recent years, and the changelog does not suggest anything related), and builds now work without those entries. Let's drop this dead weight. Tested with F26-F29, debian unstable. $ perl -i -0pe 's/\s*<authorgroup>.*<.authorgroup>//gms' man/*xml
* tree-wide: remove Lennart's copyright linesLennart Poettering2018-06-141-2/+0
| | | | | | | | | | | These lines are generally out-of-date, incomplete and unnecessary. With SPDX and git repository much more accurate and fine grained information about licensing and authorship is available, hence let's drop the per-file copyright notice. Of course, removing copyright lines of others is problematic, hence this commit only removes my own lines and leaves all others untouched. It might be nicer if sooner or later those could go away too, making git the only and accurate source of authorship information.
* tree-wide: drop 'This file is part of systemd' blurbLennart Poettering2018-06-141-2/+0
| | | | | | | | | | | | | | | | This part of the copyright blurb stems from the GPL use recommendations: https://www.gnu.org/licenses/gpl-howto.en.html The concept appears to originate in times where version control was per file, instead of per tree, and was a way to glue the files together. Ultimately, we nowadays don't live in that world anymore, and this information is entirely useless anyway, as people are very welcome to copy these files into any projects they like, and they shouldn't have to change bits that are part of our copyright header for that. hence, let's just get rid of this old cruft, and shorten our codebase a bit.
* man: merge two sections into two subsections of one sectionZbigniew Jędrzejewski-Szmek2018-04-181-18/+22
| | | | Those are very close subjects that are a good fit for one section.
* tree-wide: drop license boilerplateZbigniew Jędrzejewski-Szmek2018-04-061-13/+0
| | | | | | | | | | Files which are installed as-is (any .service and other unit files, .conf files, .policy files, etc), are left as is. My assumption is that SPDX identifiers are not yet that well known, so it's better to retain the extended header to avoid any doubt. I also kept any copyright lines. We can probably remove them, but it'd nice to obtain explicit acks from all involved authors before doing that.
* Add SPDX license identifiers to man pagesZbigniew Jędrzejewski-Szmek2017-11-191-0/+2
|
* man: explicitly distinguish "implicit dependencies" and "default dependencies"John Lin2017-09-131-9/+20
| | | | Fixes: #6793
* man: document that some unit types do not support unit aliases via symlinksLennart Poettering2016-04-291-8/+7
|
* man: clarify that DefaultDependencies= is in the [Unit] sectionLennart Poettering2016-04-121-5/+3
| | | | This hopefully reduces confusion resulting in issues like #2992.
* man: document automatic dependenciesLennart Poettering2015-11-111-3/+17
| | | | | | | | | | | For all units ensure there's an "Automatic Dependencies" section in the man page, and explain which dependencies are automatically added in all cases, and which ones are added on top if DefaultDependencies=yes is set. This is also done for systemd.exec(5), systemd.resource-control(5) and systemd.unit(5) as these pages describe common behaviour of various unit types.
* doc: correct orthography, word forms and missing/extraneous wordsJan Engelhardt2015-11-061-1/+1
|
* man: revert dynamic paths for split-usr setupsTom Gundersen2015-06-181-4/+1
| | | | | | | | | | | | | | | | | | | | | | | 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.
* man: generate configured paths in manpagesFilipe Brandenburger2015-05-281-1/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* automount: add expire supportMichael Olbrich2015-04-211-0/+8
|
* man: fix a bunch of linksZbigniew Jędrzejewski-Szmek2015-03-131-3/+3
| | | | All hail linkchecker!
* man: boilerplate unificationZbigniew Jędrzejewski-Szmek2015-02-101-1/+0
|
* Reindent man pages to 2chZbigniew Jędrzejewski-Szmek2015-02-031-142/+129
|
* man: fix references to systemctl man page which is now in section 1Michael Biebl2014-09-061-1/+1
| | | | https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=760613
* man: wording and grammar updatesJan Engelhardt2013-09-121-5/+5
| | | | | | | | | | | | This is a recurring submission and includes corrections to various issue spotted. I guess I can just skip over reporting ubiquitous comma placement fixes… Highligts in this particular commit: - the "unsigned" type qualifier is completed to form a full type "unsigned int" - alphabetic -> lexicographic (that way we automatically define how numbers get sorted)
* man: use <literal> not <filename> for suffixesZbigniew Jędrzejewski-Szmek2013-07-121-1/+1
| | | | | | | Especially sentences like "filename ends in .suffix" are easier to parse if the suffix is surrounded by quotes. In sentences like "requires a .service unit", where the suffix is used as a class designation, there is no need to use quotes.
* man: improve grammar and word formatting in numerous man pagesJason St. John2013-07-021-1/+1
| | | | | | | | | | Use proper grammar, word usage, adjective hyphenation, commas, capitalization, spelling, etc. To improve readability, some run-on sentences or sentence fragments were revised. [zj: remove the space from 'file name', 'host name', and 'time zone'.]
* man: add various filenames to the indexZbigniew Jędrzejewski-Szmek2013-05-031-1/+1
| | | | | | | | | | Everything which is an absolute filename marked with <filename></filename> lands in the index, unless noindex= attribute is present. Should make it easier for people to find stuff when they are looking at a file on disk. Various formatting errors in manpages are fixed, kernel-install(1) is restored to formatting sanity.
* man: use <replaceable> in various placesZbigniew Jędrzejewski-Szmek2013-02-131-1/+1
|
* man: extend systemd.directives(7) to all manual pagesZbigniew Jędrzejewski-Szmek2013-01-261-1/+1
| | | | | | | | | | 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.
* man: add links to directive index to see-alsosZbigniew Jędrzejewski-Szmek2013-01-151-1/+2
| | | | | systemd.directives(5) is renamed to systemd.directives(7). Section 7 is "Miscellaneous".
* man: typo fixesThomas Hindoe Paaboel Andersen2012-10-261-1/+1
| | | | | | | | | 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 8bd3b8620c80d0f2383f2fb04315411fc8077ca1
* man: reword man page titlesLennart Poettering2012-07-161-1/+1
| | | | | Make sure the man page titles are similar in style and capitalization so that our man page index looks pretty.
* relicense to LGPLv2.1 (with exceptions)Lennart Poettering2012-04-121-4/+4
| | | | | | | | | | | | | | 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.
* update man pages for recent changesLennart Poettering2010-07-071-1/+1
|
* man: document execution context related settingsLennart Poettering2010-07-021-6/+8
|
* man: document swap unitsLennart Poettering2010-07-021-4/+7
|
* man: document automount unitsLennart Poettering2010-07-021-0/+162