From: Lennart Poettering Date: Fri, 13 Jul 2012 13:49:34 +0000 (+0200) Subject: man: document sd_journal_open() X-Git-Tag: v187~103 X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=commitdiff_plain;h=3bb55eee6aecdab6bfdbb670299fa59801145cb6;hp=4b2615684b312a6457d9fdd8f455bc2a0def9bc9 man: document sd_journal_open() --- diff --git a/Makefile.am b/Makefile.am index dafd65d08..a7a1db7c0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -500,7 +500,8 @@ MANPAGES = \ man/sd_id128_randomize.3 \ man/sd-journal.3 \ man/sd_journal_print.3 \ - man/sd_journal_stream_fd.3 + man/sd_journal_stream_fd.3 \ + man/sd_journal_open.3 MANPAGES_ALIAS = \ man/reboot.8 \ @@ -540,7 +541,9 @@ MANPAGES_ALIAS = \ man/sd_id128_get_boot.3 \ man/sd_journal_printv.3 \ man/sd_journal_send.3 \ - man/sd_journal_sendv.3 + man/sd_journal_sendv.3 \ + man/sd_journal_open_directory.3 \ + man/sd_journal_close.3 man/reboot.8: man/halt.8 man/poweroff.8: man/halt.8 @@ -580,6 +583,8 @@ man/sd_id128_get_boot.3: man/sd_id128_randomize.3 man/sd_journal_printv.3: man/sd_journal_print.3 man/sd_journal_send.3: man/sd_journal_print.3 man/sd_journal_sendv.3: man/sd_journal_print.3 +man/sd_journal_open_directory.3: man/sd_journal_open.3 +man/sd_journal_close.3: man/sd_journal_open.3 XML_FILES = \ ${patsubst %.1,%.xml,${patsubst %.3,%.xml,${patsubst %.5,%.xml,${patsubst %.7,%.xml,${patsubst %.8,%.xml,$(MANPAGES)}}}}} diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml new file mode 100644 index 000000000..eb0b8c515 --- /dev/null +++ b/man/sd_journal_open.xml @@ -0,0 +1,151 @@ + + + + + + + + + sd_journal_open + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + sd_journal_open + 3 + + + + sd_journal_open + sd_journal_open_directory + sd_journal_close + Open the system journal for reading + + + + + #include <systemd/sd-journal.h> + + + int sd_journal_open + sd_journal** ret + int flags + + + + int sd_journal_open_directory + sd_journal** ret + const char* path + int flags + + + + int sd_journal_close + sd_journal* j + + + + + + Description + + sd_journal_open() opens the + the log journal for reading. It will find all journal + files automatically and interleave them automatically + when reading. As first argument it takes a pointer to + a sd_journal pointer, which on + success will contain journal context afterwards. The + second argument is a flags field, which may consist of + the following flags ORed together: + SD_JOURNAL_LOCAL_ONLY makes sure + only journal files generated on the local machine will + be opened. SD_JOURNAL_RUNTIME_ONLY + makes sure only volatile journal files will be opened, + excluding those which are stored on persistant + storage. SD_JOURNAL_RUNTIME_ONLY + will ensure that only journal files of system services + and the kernel (in opposition to user session processes) will + be opened. + + sd_journal_open_directory() + is similar to sd_journal_open() + but takes an absolute directory path as argument. All + journal files in this directory will be opened and + interleaved automatically. This call also takes a + flags argument, but it must be passed as 0 as no flags + are currently understood for this call. + + sd_journal_close() will + close the journal context allocated with + sd_journal_open() or + sd_journal_open_directory() and + free its resources. + + When opening the journal only journal files + accessible to the calling user will be opened. If + journal files are not accessible to the caller this + will be silently ignored. + + + + Return Value + + The sd_journal_open() and + sd_journal_open_directory() calls + return 0 on success or a negative errno-style error + code. sd_journal_close() returns + nothing. + + + + Notes + + The sd_journal_open(), + sd_journal_open_directory() and + sd_journal_close() interfaces are + available as shared library, which can be compiled and + linked to with the + libsystemd-journal + pkg-config1 + file. + + + + See Also + + + systemd1, + sd-journal3, + sd_journal_next3, + sd_journal_get_data3 + + + +