summaryrefslogtreecommitdiff
path: root/man/file-hierarchy.xml
Commit message (Collapse)AuthorAgeFilesLines
* Fix cross-reference of manual for LogsDirectoryFranklin Yu2023-04-131-1/+1
|
* Use https for freedesktop.orgMichael Biebl2022-06-281-3/+3
| | | | grep -l -r http:// | xargs sed -E -i s'#http://(.*).freedesktop.org#https://\1.freedesktop.org#'
* tree-wide: streamline wiki linksBenjamin Franzke2022-05-211-2/+2
| | | | | | | | * Avoid traling slash as most links are defined without. * Always use https:// protocol and www. subdomain Allows for easier tree-wide linkvalidation for our migration to systemd.io.
* file-hierarchy: Document /sys/fs/cgroupJosh Triplett2022-03-011-0/+19
| | | | | | | | | | | | | | file-hierarchy does not mention anything about the expected mountpoint for cgroups. This may lead some software to believe it will need to search for it (e.g. by scanning mountinfo) rather than just looking in the canonical location. Document the canonical mountpoint as /sys/fs/cgroup. Also provide information on the non-default configurations, but make it clear that in such configurations if cgroup2 is mounted (hybrid mode) it won't have resource controllers attached. This will help software know if it should fall back to /sys/fs/cgroup/unified or just ignore that case.
* man: add discussion of read-only filesystem support in daemonsZbigniew Jędrzejewski-Szmek2021-10-061-56/+72
| | | | | This is inspired by https://bugzilla.redhat.com/show_bug.cgi?id=1853293. Let's mention that applications should be prepared for /var being read-only.
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* man: add a note about flags on /tmp and /var/tmpZbigniew Jędrzejewski-Szmek2020-10-051-0/+13
| | | | Inspired by https://bugzilla.redhat.com/show_bug.cgi?id=1875340.
* man: use paragraphs in descriptions of /tmp and /var/tmpZbigniew Jędrzejewski-Szmek2020-10-051-24/+29
| | | | | | | We have three somewhat separate ideas: what the directory is for, what $TMPDIR is for, and security considerations. Let's use paragraphs. Also, conjunctions in titles aren't capitalized usually.
* man: adjustments in file-hierarchy(7)Zbigniew Jędrzejewski-Szmek2020-09-301-23/+19
| | | | | | | In table titles, capitalize only the first word (they are rather long and it is easier to read when it looks like a normal sentence). Adjust some phrases to make them clearer when reported as unclear in #17177.
* tree-wide: fixes for assorted grammar and spelling issuesZbigniew Jędrzejewski-Szmek2020-07-061-1/+1
| | | | Fixes #16363. Also includes some changes where I generalized the pattern.
* 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,units: link up new documentation about temporary directoriesLennart Poettering2019-02-201-35/+31
|
* 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: suffix all dir paths in file-hierarchy(7) with "/"Lennart Poettering2018-05-021-95/+95
| | | | | | | | Our CODING_STYLE document suggests to suffix all paths referring to dirs rather than regular files with a "/" in our docs and log messages. Update file-hierarchy(7) to do just that. No other changes.
* man: document /efi in file-hiearchy(7)Lennart Poettering2018-05-021-1/+10
| | | | | We have been supporting the directory since a while in the gpt generator, let's document it in file-hierarchy(7) too
* man: document the XDG specs as further sources of specifications for ↵Lennart Poettering2018-05-021-10/+10
| | | | | | | | file-hierarchy(7) We document this further down in the text, but let's also list this early on, where we mention the FHS as major influence too, so that it is clear we incorporate all that thinking.
* tree-wide: drop spurious newlines (#8764)Lennart Poettering2018-04-191-1/+0
| | | | | | | | Double newlines (i.e. one empty lines) are great to structure code. But let's avoid triple newlines (i.e. two empty lines), quadruple newlines, quintuple newlines, …, that's just spurious whitespace. It's an easy way to drop 121 lines of code, and keeps the coding style of our sources a bit tigther.
* 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.
* man: link latest FHS spec in file-hierarchy(7) (#8178)Jan Synacek2018-02-141-1/+1
|
* man: further file-hierarchy *Directory= improvementsLucas Werkmeister2017-12-261-4/+4
| | | | | | | | | | | | | | | | | | Follow-up to @poettering’s comments in #7723: - Slightly expand on the difference between using tmpfiles.d and service directives - Mention CacheDirectory= - Mention LogsDirectory= - Abbreviate and unify some later descriptions ConfigDirectory= is not mentioned, since it does not support the functionality mentioned in the manpage which tmpfiles.d provides: copying or symlinking default configuration from /usr/share/factory. And the user package variable file locations don’t mention the directives because in user units the service can always create the directories itself (whereas in system units lesser-privileged services lack permission to create them).
* man: mention StateDirectory in file-hierarchy(7)Lucas Werkmeister2017-12-231-4/+4
|
* Add SPDX license identifiers to man pagesZbigniew Jędrzejewski-Szmek2017-11-191-0/+2
|
* man: use https:// in URLsAsciiWolf2017-02-211-1/+1
|
* doc: improved wording in some placesJan Engelhardt2016-01-281-1/+1
| | | | | Avoid "mountpoint mounted" (word repetition), "queriable" (no match in m-w.com and dict.cc).
* doc: correct orthography, word forms and missing/extraneous wordsJan Engelhardt2015-11-061-6/+6
|
* doc: correct punctuation and improve typography in documentationJan Engelhardt2015-11-061-30/+30
|
* gpt-auto-generator: merge efi-boot-generatorKay Sievers2015-07-291-2/+2
|
* 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.
* build-sys: move systemd.pc from pkgconfiglibdir back into pkgconfigdatadirLennart Poettering2015-04-211-1/+0
| | | | | | | | | | | | | | | | | The original idea of systemd.pc was to contain arch-independent system and systemd information. By exposing libdir as part of the fields (added in eb39a6239c631873db62f6a942e6cb3dab0a2db4), it started to carry arch-dependent data, thus breaking multilib systems. It was then moved to pkgconfiglibdir to deal with this (in aec432c6134146e138124c4130be2ee89dca07fa), but actually the right approach is to simply not include libdir in the .pc file at all. THis patch hence more or less reverts both commits again, and moves the .pc file back into pkgconfigdatadir. As alternative for querying the systems primary libdir there's now "systemd-path system-library-arch", hence a more correct alternative exists for querying this variable from the .pc file.
* man: fix line breaks in code examplesLennart Poettering2015-03-311-3/+3
|
* man: fix a bunch of linksZbigniew Jędrzejewski-Szmek2015-03-131-1/+1
| | | | All hail linkchecker!
* Reindent man pages to 2chZbigniew Jędrzejewski-Szmek2015-02-031-952/+790
|
* Fix a few more typosRuben Kerkhof2014-08-301-1/+1
|
* man: add a mapping for external manpagesZbigniew Jędrzejewski-Szmek2014-07-071-11/+11
| | | | | | | | | | | | | | | | | | | | | | | | It is annoying when we have dead links on fd.o. Add project='man-pages|die-net|archlinux' to <citerefentry>-ies. In generated html, add external links to http://man7.org/linux/man-pages/man, http://linux.die.net/man/, https://www.archlinux.org/. By default, pages in sections 2 and 4 go to man7, since Michael Kerrisk is the autorative source on kernel related stuff. The rest of links goes to linux.die.net, because they have the manpages. Except for the pacman stuff, since it seems to be only available from archlinux.org. Poor gummiboot gets no link, because gummitboot(8) ain't to be found on the net. According to common wisdom, that would mean that it does not exist. But I have seen Kay using it, so I know it does, and deserves to be found. Can somebody be nice and put it up somewhere?
* man: add link to Open Group Base SpecificationsZbigniew Jędrzejewski-Szmek2014-07-031-2/+5
|
* man: /usr/bin may contain binaries in any compatible arch, not just the ↵Lennart Poettering2014-07-031-1/+1
| | | | primary one
* man: fix links to systemd-efi-boot-generator(8)Lennart Poettering2014-07-031-2/+2
|
* path: add new "systemd-path" utility for querying paths described in ↵Lennart Poettering2014-07-021-4/+16
| | | | | | | | file-hierarchy(7) This new tool is based on "sd-path", a new (so far unexported) API for libsystemd, that can hopefully grow into a workable API covering /opt and more one day.
* typo fixesThomas Hindoe Paaboel Andersen2014-07-011-6/+6
|
* man: file-hierarchy - emphasize /usr/lib/$arch-id instead of $libdirKay Sievers2014-07-011-13/+11
|
* man: document directories in $HOME, too, in file-hierarchy(7)Lennart Poettering2014-07-011-16/+229
|
* man: extend a bit what to expect from the various places apps can store dataLennart Poettering2014-07-011-6/+8
|
* man: add sections about file node types and write access to file-hierarchy(7)Lennart Poettering2014-07-011-0/+49
|
* man: reference $TMPDIR, not $TMP in file-hierarchy(7)Lennart Poettering2014-07-011-7/+7
| | | | | This what environ(7) and POSIX define, so that's what we should reference.
* man: file-hierarchy - minor fixesTom Gundersen2014-07-011-13/+9
| | | | Leave non-specified top-level dirs out of the spec, and minor cleanups.
* man: document how to query $libdir for the primary architecture using pkg-configLennart Poettering2014-06-301-2/+6
|