summaryrefslogtreecommitdiffstats
path: root/man/sd_journal_stream_fd.xml (follow)
Commit message (Collapse)AuthorAgeFilesLines
* sd-journal: introduce sd_journal_stream_fd_with_namespaceMike Yuan2024-03-141-19/+31
|
* man: use same version in public and system ident.David Tardon2023-12-251-1/+1
|
* man: use <simplelist> for 'See also' sectionsDavid Tardon2023-12-231-9/+9
| | | | | This is just a slight markup improvement; there should be no difference in rendering.
* man: add version information for functionsAbderrahim Kitouni2023-09-041-0/+5
|
* man: use external .c files for three examplesZbigniew Jędrzejewski-Szmek2022-10-111-27/+1
| | | | | | | | This way it's much easier to test that the code compiles without issues. It's also easier to edit the code. Indentation in one of the examples is reduced to two spaces. This is what we use in man pages to make them fit on screen better.
* license: LGPL-2.1+ -> LGPL-2.1-or-laterYu Watanabe2020-11-091-1/+1
|
* 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: correct journald field nameChris Morin2018-08-221-1/+1
|
* man: be more explicit about thread safety of sd_journalLennart Poettering2018-08-031-2/+1
| | | | | | | | | | | | | Triggered by https://bugzilla.redhat.com/show_bug.cgi?id=1609349 This adds two generic paragaphs we include via xinclude. One is the "strict" version, which contains wording saying that we are thread agnostic and what that means. And the other is the "safe" version, for the cases we provide fully safety. Let's then change most man pages to use either of these generic paragraphs. With one exception: man/sd_journal_get_catalog.xml contains both kinds of function, we hence use manual wording.
* 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: xinclude the generic text to talk about libsystemd pkgconfigZbigniew Jędrzejewski-Szmek2018-06-061-6/+2
| | | | | | | The only difference is that functions are not individually listed by name, but that seems completely pointless, since all functions that are documented are always exported, so the generic text tells the user all she or he needs to know.
* 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: it appears the description of async signal safety has its own man page nowLennart Poettering2018-01-231-2/+2
| | | | Let's refer to the new page.
* man: document explicitly that sd_journal_stream_fd() never shares fdsLennart Poettering2018-01-231-0/+4
| | | | | Also, clarify that O_NONBLOCK is turned off and that the fd is only half-open.
* man: document that sd_j_stream_fd is signal safe (#7942)Zbigniew Jędrzejewski-Szmek2018-01-211-0/+8
| | | Fixes #7912.
* man: sd_journal_stream_fd: no, fds are not shared (#7926)Alan Jenkins2018-01-201-2/+1
| | | | | | | | | | | | sd_journal_stream_fd() does not return the same file descriptor across different calls. It can't possibly do so, because the file descriptor is created using certain parameters passed by the caller. Also the implementation clearly isn't doing this, it's just connecting to a unix socket. It opens exactly one file descriptor, and does not close it unless there is a write failure. Nothing like "temporarily multiple file descriptors may be open".
* Add SPDX license identifiers to man pagesZbigniew Jędrzejewski-Szmek2017-11-191-0/+2
|
* man: fix typos (#4527)Jakub Wilk2016-10-311-1/+1
|
* man: add notes about thread safety of sd_journal_* functionsZbigniew Jędrzejewski-Szmek2016-10-161-0/+4
| | | | Fixes #4056.
* 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.
* Reindent man pages to 2chZbigniew Jędrzejewski-Szmek2015-02-041-135/+128
|
* Use log "level" instead of "priority"Zbigniew Jędrzejewski-Szmek2014-11-011-1/+1
| | | | | | | | | | | | The term "priority" is misleading because higher levels have lower priority. "Level" is clearer and shorter. This commit touches only the textual descriptions, not function and variable names themselves. "Priority" is used in various command-line switches and protocol constants, so completly getting rid of "priority" is hard. I also left "priority" in various places where the clarity suffered when it was removed.
* man: add a mapping for external manpagesZbigniew Jędrzejewski-Szmek2014-07-081-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | 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?
* doc: balance C indirections in function prototypesJan Engelhardt2014-05-081-1/+1
| | | | | | | | Shift the asterisks in the documentation's prototypes such that they are consistent among each other. Use the right side to match what is used in source code. Addendum to commit v209~82.
* man: fix references to .pc files which aren't separate anymoreLennart Poettering2014-02-191-1/+1
|
* man: replace STDOUT with standard output, etc.Zbigniew Jędrzejewski-Szmek2014-02-151-2/+2
| | | | | | | | | Actually 'STDOUT' is something that doesn't appear anywhere: in the stdlib we have 'stdin', and there's only the constant STDOUT_FILENO, so there's no reason to use capitals. When refering to code, STDOUT/STDOUT/STDERR are replaced with stdin/stdout/stderr, and in other places they are replaced with normal phrases like standard output, etc.
* man: resolve word omissionsJan Engelhardt2013-12-261-1/+1
| | | | | This is a recurring submission and includes corrections to: word omissions and word class choice.
* man: improve grammar and word formatting in numerous man pagesJason St. John2013-07-031-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: fix spacing issue in various man pagesJason St. John2013-06-291-2/+1
| | | | | | | | | | | | | Before: libsystemd-daemonpkg-config(1) After: libsystemd-daemon pkg-config(1) This fix is more complicated than it should be due to the consecutive XML elements separated by collapsible whitespace. Merging the lines and separating the XML elements with an en space or a non-breaking space is the only solution that results in one, and only one, space being inserted between them when testing. An em space results in two spaces being inserted.
* man: use <constant> for various constants which look ugly with quotesZbigniew Jędrzejewski-Szmek2013-06-271-10/+10
|
* 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: fix various typosLennart Poettering2012-07-131-0/+1
|
* man: document sd_journal_next()Lennart Poettering2012-07-131-0/+2
|
* man: document sd_journal_stream_fd()Lennart Poettering2012-07-131-0/+168