summaryrefslogtreecommitdiff
path: root/man/systemd.generator.xml
Commit message (Collapse)AuthorAgeFilesLines
* man: Fix user generator output pathsDaan De Meyer2023-03-131-5/+5
| | | | | These are all under $XDG_RUNTIME_DIR/systemd instead of directly under $XDG_RUNTIME_DIR.
* man: fix typo in systemd.generatorAntonio Alvarez Feijoo2023-02-281-1/+1
|
* man: strengthen language about generator outputZbigniew Jędrzejewski-Szmek2023-02-011-0/+5
| | | | Inspired by https://bugzilla.redhat.com/show_bug.cgi?id=2165433.
* tree-wide: also settle on "initrd" instead of "initial RAM disk"Lennart Poettering2022-09-231-4/+3
| | | | | With this the concept is now called the same way everywhere except where historical info is relevant or where the other names are API.
* generators: accept one or three args, do not write to /tmpZbigniew Jędrzejewski-Szmek2022-07-151-10/+11
| | | | | | | | | | | | | | | | | | | Since the general generator logic was established in the rewrite in 07719a21b6425d378b36bb8d7f47ad5ec5296d28, generators would always write to /tmp by default. I think this not a good default at all, because generators write a bunch of files and would create a mess in /tmp. And for debugging, one generally needs to remove all the files in the output directory, because generators will complain in the output paths are already present. Thus the approach of disabling console logging and writing many files to /tmp when invoked with no arguments is not nice, so let's disallow operation with no args. But when debugging, one generally does not care about the separate output dirs (most generators use only one). Thus the general pattern I use is something like: rm -rf /tmp/x && mkdir /tmp/x && build/some-generator /tmp/{x,x,x} This commit allows only one directory to be specified and simplifies this to: rm -rf /tmp/x && mkdir /tmp/x && build/some-generator /tmp/x
* man: document new generator env varsLennart Poettering2022-04-131-0/+60
|
* man: rebreak all paragraphs in systemd.generator(7)Lennart Poettering2022-04-131-113/+88
|
* man: use readable names for entitiesZbigniew Jędrzejewski-Szmek2021-05-191-4/+4
| | | | Let's use the same names as in the jinja2 substitutions.
* man: various improvements to systemd.generator(7)Lennart Poettering2021-02-231-22/+27
| | | | | | | In particular, make clear the .d/*.conf unit file drop-ins are OK to generate from generators. Inspired by: https://lists.freedesktop.org/archives/systemd-devel/2021-February/046148.html
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* man: use trailing slash on directories in more placesZbigniew Jędrzejewski-Szmek2020-10-051-15/+15
|
* man: Add systemd-xdg-autostart-generator man pageBenjamin Berg2020-05-271-0/+1
|
* man: fix a few bogus entries in directives indexZbigniew Jędrzejewski-Szmek2019-11-211-1/+1
| | | | | | When wrong element types are used, directives are sometimes placed in the wrong section. Also, strip part of text starting with "'", which is used in a few places and which is displayed improperly in the index.
* man: tell generator writers to provide authorship and source informationZbigniew Jędrzejewski-Szmek2019-03-151-6/+9
| | | | | | | Our generators always put a comment who generated the file, but we didn't recommend it to others. Let's also strengthen the advice to use SourcePath=.
* 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: use singular “they”Lucas Werkmeister2018-08-231-1/+1
| | | | | | | | | | | | For an example where we already use it, see man:sd-login(3): > A session is defined by the time a user is logged in until they log out. As far as I can tell, this removes the only remaining occurrences of referring to users by gendered pronouns in our documentation (though some still survive in code comments and the NEWS and TODO files): git grep '\b\(he\|him\|his\|she\|her\|hers\)\b' man/
* Merge pull request #9301 from keszybz/man-drop-authorgroupLennart Poettering2018-06-141-9/+0
|\ | | | | man: drop unused <authorgroup> tags from man sources
| * 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
* | Drop my copyright headersZbigniew Jędrzejewski-Szmek2018-06-141-2/+0
|/ | | | | | | perl -i -0pe 's/\s*Copyright © .... Zbigniew Jędrzejewski.*?\n/\n/gms' man/*xml git grep -e 'Copyright.*Jędrzejewski' -l | xargs perl -i -0pe 's/(#\n)?# +Copyright © [0-9, -]+ Zbigniew Jędrzejewski.*?\n//gms' git grep -e 'Copyright.*Jędrzejewski' -l | xargs perl -i -0pe 's/\s*\/\*\*\*\s+Copyright © [0-9, -]+ Zbigniew Jędrzejewski[^\n]*?\s*\*\*\*\/\s*/\n\n/gms' git grep -e 'Copyright.*Jędrzejewski' -l | xargs perl -i -0pe 's/\s+Copyright © [0-9, -]+ Zbigniew Jędrzejewski[^\n]*//gms'
* tree-wide: beautify remaining copyright statementsLennart Poettering2018-06-141-1/+1
| | | | | | Let's unify an beautify our remaining copyright statements, with a unicode ©. This means our copyright statements are now always formatted the same way. Yay.
* 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.
* 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: make Notes section in systemd.geneator(5) toplevelZbigniew Jędrzejewski-Szmek2018-02-091-147/+120
| | | | This is mostly a indentation change and rewrapping.
* man: document unit load pathsZbigniew Jędrzejewski-Szmek2018-02-091-29/+53
| | | | | | | | | | | | | | | | So far we didn't document control, transient, dbus config, or generator paths. But those paths are visible to users, and they need to understand why systemd loads units from those paths, and how the precedence hierarchy looks. The whole thing is a bit messy, since the list of paths is quite long. I made the tables a bit shorter by combining rows for the alternatives where $XDG_* is set and the fallback. In various places, tags are split like <element param="blah"> this. This is necessary to keep everyting in one logical XML line so that docbook renders the table properly. Replaces #8050.
* man: fix typoДилян Палаузов2018-01-161-1/+1
| | | | Closes #7866.
* man: add a systemd-rc-local-generator(8) man pageLennart Poettering2017-12-261-0/+1
| | | | | | | Most importantly, let's highlight the differences to the rc-local behaviour in SysV. Fixes: #7703
* man: "systemd" is to be written in all lower-case, even at beginnings of ↵Lennart Poettering2017-12-131-1/+1
| | | | | | sentences This very important commit is very important.
* Add SPDX license identifiers to man pagesZbigniew Jędrzejewski-Szmek2017-11-191-0/+2
|
* man: document that generators can generate instances+templates and regular ↵Lennart Poettering2017-11-161-18/+12
| | | | | | | | unit files (#7342) This addition is kept brief on purpose, since in order to write a good generator users don't really need to grok templating/instantiation. Fixes: #7257
* man: mention /run in systemd.generator document (#7121)John Lin2017-10-181-2/+3
|
* man: add systemd.environment-generator(7) with two examplesZbigniew Jędrzejewski-Szmek2017-02-201-1/+2
| | | | | | | | | v2: - add example files to EXTRA_DIST v3: - rework for the new scheme where nothing is written to disk v4: - use separate dirs for system and user env generators
* man: cite systemd.offline-updates(7) instead of linking to old wiki pageZbigniew Jędrzejewski-Szmek2016-05-281-2/+2
|
* man: punctuation fixesZbigniew Jędrzejewski-Szmek2016-05-281-2/+2
| | | | Fixes #3376.
* man: clarify that generators are run before /varZbigniew Jędrzejewski-Szmek2016-02-061-6/+9
| | | | | Just a clarification. At least systemd-openqa-generator from openqa gets this wrong.
* man: fix typosJakub Wilk2016-01-151-1/+1
|
* doc: use expanded forms for written styleJan Engelhardt2015-11-061-1/+1
|
* doc: correct orthography, word forms and missing/extraneous wordsJan Engelhardt2015-11-061-4/+4
|
* doc: correct punctuation and improve typography in documentationJan Engelhardt2015-11-061-8/+8
|
* gpt-auto-generator: merge efi-boot-generatorKay Sievers2015-07-291-1/+0
|
* man: revert dynamic paths for split-usr setupsTom Gundersen2015-06-181-2/+2
| | | | | | | | | | | | | | | | | | | | | | | 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-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* treewide: Correct typos and spell plural of bus consistentTorstein Husebø2015-05-111-1/+1
|
* man: fix a bunch of linksZbigniew Jędrzejewski-Szmek2015-03-131-1/+1
| | | | All hail linkchecker!
* man: fix typoTorstein Husebø2015-02-111-1/+1
|
* man: add systemd.generator(7)Zbigniew Jędrzejewski-Szmek2015-02-101-0/+346
This is largely based on http://www.freedesktop.org/wiki/Software/systemd/Generators/, and obsoletes that page. It seems that we do a much better job of keeping man pages up-to-date compared to wiki pages. Man pages are also easier to find for users. https://bugs.freedesktop.org/show_bug.cgi?id=89048