From cb07866b1b7c11e687a322d70dd9f9d73bbbe488 Mon Sep 17 00:00:00 2001 From: Lennart Poettering Date: Fri, 13 Jul 2012 01:50:05 +0200 Subject: [PATCH] man: move header file man pages from section 7 to 3 This way we can include documentation about minor macros/inline function within the introducionary man page in a sane way. --- Makefile.am | 20 ++++++++++---------- man/daemon.xml | 6 +++--- man/machine-id.xml | 2 +- man/sd-daemon.xml | 4 ++-- man/sd-id128.xml | 2 +- man/sd-journal.xml | 4 ++-- man/sd-login.xml | 6 +++--- man/sd-readahead.xml | 4 ++-- man/sd_booted.xml | 4 ++-- man/sd_get_seats.xml | 2 +- man/sd_id128_randomize.xml | 4 ++-- man/sd_id128_to_string.xml | 6 +++--- man/sd_is_fifo.xml | 4 ++-- man/sd_journal_print.xml | 2 +- man/sd_listen_fds.xml | 4 ++-- man/sd_login_monitor_new.xml | 2 +- man/sd_notify.xml | 4 ++-- man/sd_pid_get_session.xml | 2 +- man/sd_readahead.xml | 4 ++-- man/sd_seat_get_active.xml | 2 +- man/sd_session_is_active.xml | 2 +- man/sd_uid_get_state.xml | 2 +- man/systemd-journald.service.xml | 2 +- man/systemd.exec.xml | 4 ++-- man/systemd.journal-fields.xml | 2 +- man/systemd.xml | 2 +- src/systemd/sd-daemon.h | 2 +- src/systemd/sd-id128.h | 2 ++ src/systemd/sd-journal.h | 2 ++ src/systemd/sd-login.h | 2 ++ src/systemd/sd-readahead.h | 2 +- 31 files changed, 59 insertions(+), 53 deletions(-) diff --git a/Makefile.am b/Makefile.am index 507ea3acd..a06b0ca6a 100644 --- a/Makefile.am +++ b/Makefile.am @@ -495,10 +495,10 @@ MANPAGES = \ man/systemd-system-update-generator.8 \ man/systemd-fstab-generator.8 \ man/systemd.preset.5 \ - man/sd-id128.7 \ + man/sd-id128.3 \ man/sd_id128_to_string.3 \ man/sd_id128_randomize.3 \ - man/sd-journal.7 \ + man/sd-journal.3 \ man/sd_journal_print.3 MANPAGES_ALIAS = \ @@ -568,11 +568,11 @@ man/systemd-ask-password-wall.path.8: man/systemd-ask-password-console.service.8 man/systemd-tmpfiles-setup.service.8: man/systemd-tmpfiles.8 man/systemd-tmpfiles-clean.service.8: man/systemd-tmpfiles.8 man/systemd-tmpfiles-clean.timer.8: man/systemd-tmpfiles.8 -man/sd_id128_t.7: man/sd-id128.7 -man/SD_ID128_MAKE.7: man/sd-id128.7 -man/SD_ID128_FORMAT_STR.7: man/sd-id128.7 -man/SD_ID128_FORMAT_VAL.7: man/sd-id128.7 -man/sd_id128_equal.7: man/sd-id128.7 +man/sd_id128_t.3: man/sd-id128.3 +man/SD_ID128_MAKE.3: man/sd-id128.3 +man/SD_ID128_FORMAT_STR.3: man/sd-id128.3 +man/SD_ID128_FORMAT_VAL.3: man/sd-id128.3 +man/sd_id128_equal.3: man/sd-id128.3 man/sd_id128_from_string.3: man/sd_id128_to_string.3 man/sd_id128_get_machine.3: man/sd_id128_randomize.3 man/sd_id128_get_boot.3: man/sd_id128_randomize.3 @@ -1409,7 +1409,7 @@ pkgconfiglib_DATA += \ src/libsystemd-daemon/libsystemd-daemon.pc MANPAGES += \ - man/sd-daemon.7 \ + man/sd-daemon.3 \ man/sd_notify.3 \ man/sd_listen_fds.3 \ man/sd_is_fifo.3 \ @@ -2535,7 +2535,7 @@ EXTRA_DIST += \ MANPAGES += \ man/sd_readahead.3 \ - man/sd-readahead.7 \ + man/sd-readahead.3 \ man/systemd-readahead-replay.service.8 MANPAGES_ALIAS += \ @@ -3099,7 +3099,7 @@ nodist_udevrules_DATA += \ MANPAGES += \ man/systemd-logind.service.8 \ man/logind.conf.5 \ - man/sd-login.7 \ + man/sd-login.3 \ man/loginctl.1 \ man/sd_login_monitor_new.3 \ man/sd_pid_get_session.3 \ diff --git a/man/daemon.xml b/man/daemon.xml index 66e198abb..83143dc4b 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -345,7 +345,7 @@ StandardError=syslog in the service unit file. For details see - sd-daemon7 + sd-daemon3 and systemd.exec5. @@ -468,7 +468,7 @@ this scheme provided by systemd see sd_listen_fds3 and - sd-daemon7. For + sd-daemon3. For details about porting existing daemons to socket-based activation see below. With minimal effort it is possible to implement @@ -938,7 +938,7 @@ fi See Also systemd1, - sd-daemon7, + sd-daemon3, sd_listen_fds3, sd_notify3, daemon3, diff --git a/man/machine-id.xml b/man/machine-id.xml index a42c7bb5a..50295a8cd 100644 --- a/man/machine-id.xml +++ b/man/machine-id.xml @@ -137,7 +137,7 @@ id[8] = (id[8] & 0x3F) | 0x80; hostname5, machine-info5, os-release5, - sd-id1287, + sd-id1283, sd_id128_get_machine3 diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index 31115a5d6..e29e2fc34 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -39,7 +39,7 @@ sd-daemon - 7 + 3 @@ -164,7 +164,7 @@ systemd.service5, systemd.socket5, fprintf3, - sd-readahead7, + sd-readahead3, pkg-config1 diff --git a/man/sd-id128.xml b/man/sd-id128.xml index ea4e3a4fd..d3f995e00 100644 --- a/man/sd-id128.xml +++ b/man/sd-id128.xml @@ -39,7 +39,7 @@ sd-id128 - 7 + 3 diff --git a/man/sd-journal.xml b/man/sd-journal.xml index 048545853..a771f0236 100644 --- a/man/sd-journal.xml +++ b/man/sd-journal.xml @@ -39,7 +39,7 @@ sd-journal - 7 + 3 @@ -117,7 +117,7 @@ sd_journal_get_cursor3, sd_journal_cutoff_realtime_usec3, journalctl1, - sd-id1287, + sd-id1283, pkg-config1 diff --git a/man/sd-login.xml b/man/sd-login.xml index acb78ac68..c02ad0c14 100644 --- a/man/sd-login.xml +++ b/man/sd-login.xml @@ -39,7 +39,7 @@ sd-login - 7 + 3 @@ -137,8 +137,8 @@ sd_seat_get_active3, sd_get_seats3, sd_login_monitor_new3, - sd-daemon7, - sd-readahead7, + sd-daemon3, + sd-readahead3, pkg-config1 diff --git a/man/sd-readahead.xml b/man/sd-readahead.xml index 4eed56ad3..484e1273b 100644 --- a/man/sd-readahead.xml +++ b/man/sd-readahead.xml @@ -39,7 +39,7 @@ sd-readahead - 7 + 3 @@ -110,7 +110,7 @@ systemd1, sd_readahead3, - sd-daemon7 + sd-daemon3 diff --git a/man/sd_booted.xml b/man/sd_booted.xml index 62d6e5741..23caf5bf1 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -109,7 +109,7 @@ may copy the implementation into their source tree. For more details about the reference implementation see - sd_daemon7. + sd-daemon3. If the reference implementation is used as drop-in files and -DDISABLE_SYSTEMD is set during @@ -121,7 +121,7 @@ See Also systemd1, - sd_daemon7 + sd-daemon3 diff --git a/man/sd_get_seats.xml b/man/sd_get_seats.xml index d30d193a5..28d06e984 100644 --- a/man/sd_get_seats.xml +++ b/man/sd_get_seats.xml @@ -119,7 +119,7 @@ systemd1, - sd-login7, + sd-login3, sd_session_get_seat3 diff --git a/man/sd_id128_randomize.xml b/man/sd_id128_randomize.xml index 1e23596f4..cb3741966 100644 --- a/man/sd_id128_randomize.xml +++ b/man/sd_id128_randomize.xml @@ -114,7 +114,7 @@ For more information about the sd_id128_t type see - sd-id1287. + sd-id1283. journalctl1's --new-id command may be used as @@ -148,7 +148,7 @@ systemd1, - sd-id1287, + sd-id1283, machine-id5, random4 diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml index 3a171550e..eda35b08b 100644 --- a/man/sd_id128_to_string.xml +++ b/man/sd_id128_to_string.xml @@ -84,7 +84,7 @@ For more information about the sd_id128_t type see - sd-id1287. + sd-id1283. When formatting a 128 bit ID into a string it is often easier to use a format string for @@ -93,7 +93,7 @@ SD_ID128_FORMAT_STR and SD_ID128_FORMAT_VAL() macros. For more information see - sd-id1287. + sd-id1283. @@ -123,7 +123,7 @@ systemd1, - sd-id1287, + sd-id1283, printf3 diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index 289e1ba13..a41447b63 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -196,7 +196,7 @@ may copy the implementation into their source tree. For more details about the reference implementation see - sd_daemon7. + sd-daemon3. These functions continue to work as described, even if -DDISABLE_SYSTEMD is set during @@ -207,7 +207,7 @@ See Also systemd1, - sd-daemon7, + sd-daemon3, sd_listen_fds3, systemd.service5, systemd.socket5 diff --git a/man/sd_journal_print.xml b/man/sd_journal_print.xml index 2d5d3639c..71551f779 100644 --- a/man/sd_journal_print.xml +++ b/man/sd_journal_print.xml @@ -213,7 +213,7 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid( systemd1, - sd-journal7, + sd-journal3, sd_journal_stream_fd3, syslog3, systemd.journal-fields7 diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index e76630e4f..003c1b51e 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -156,7 +156,7 @@ may copy the implementation into their source tree. For more details about the reference implementation see - sd-daemon7. + sd-daemon3. If the reference implementation is used as drop-in files and -DDISABLE_SYSTEMD is set during @@ -189,7 +189,7 @@ systemd1, - sd-daemon7, + sd-daemon3, sd_is_fifo3, sd_is_socket3, sd_is_socket_inet3, diff --git a/man/sd_login_monitor_new.xml b/man/sd_login_monitor_new.xml index 4642e99f7..102d943f9 100644 --- a/man/sd_login_monitor_new.xml +++ b/man/sd_login_monitor_new.xml @@ -164,7 +164,7 @@ systemd1, - sd-login7, + sd-login3, sd_get_seats3 diff --git a/man/sd_notify.xml b/man/sd_notify.xml index a91c1bb4b..1cd5b0aa7 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -243,7 +243,7 @@ file. Alternatively, applications consuming these APIs may copy the implementation into their source tree. For more details about the reference implementation see - sd_daemon7. + sd-daemon3. If the reference implementation is used as drop-in files and -DDISABLE_SYSTEMD is set during @@ -310,7 +310,7 @@ See Also systemd1, - sd_daemon7, + sd-daemon3, daemon7, systemd.service5 diff --git a/man/sd_pid_get_session.xml b/man/sd_pid_get_session.xml index 9a1b1997d..7897a2cd3 100644 --- a/man/sd_pid_get_session.xml +++ b/man/sd_pid_get_session.xml @@ -151,7 +151,7 @@ systemd1, - sd-login7, + sd-login3, sd_session_is_active3, getsid2 diff --git a/man/sd_readahead.xml b/man/sd_readahead.xml index 2a9272788..ff7b35574 100644 --- a/man/sd_readahead.xml +++ b/man/sd_readahead.xml @@ -140,7 +140,7 @@ recommended that applications consuming this API copy the implementation into their source tree. For more details about the reference implementation see - sd-readahead7 + sd-readahead3 If -DDISABLE_SYSTEMD is set during compilation this function will always return 0 and otherwise @@ -170,7 +170,7 @@ sd_readahead("noreplay"); See Also systemd1, - sd-readahead7, + sd-readahead3, daemon7 diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml index 82a1ea048..fa4737857 100644 --- a/man/sd_seat_get_active.xml +++ b/man/sd_seat_get_active.xml @@ -172,7 +172,7 @@ systemd1, - sd-login7, + sd-login3, sd_session_get_seat3 diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml index a14286aea..a9107cb95 100644 --- a/man/sd_session_is_active.xml +++ b/man/sd_session_is_active.xml @@ -232,7 +232,7 @@ systemd1, - sd-login7, + sd-login3, sd_pid_get_session3 diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml index f302b34c6..b9b713c64 100644 --- a/man/sd_uid_get_state.xml +++ b/man/sd_uid_get_state.xml @@ -181,7 +181,7 @@ systemd1, - sd-login7, + sd-login3, sd_pid_get_owner_uid3 diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml index 3c71a59c9..8ae24d40b 100644 --- a/man/systemd-journald.service.xml +++ b/man/systemd-journald.service.xml @@ -166,7 +166,7 @@ journalctl1, journald.conf5, systemd.journal-fields7, - sd-journal7 + sd-journal3 diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 01b638f5a..8d3b3da22 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -551,7 +551,7 @@ prefixes may be disabled with SyslogLevelPrefix=, see below. For details see - sd-daemon7. + sd-daemon3. Defaults to . @@ -573,7 +573,7 @@ these prefixes is disabled and the logged lines are passed on as-is. For details about this prefixing see - sd-daemon7. + sd-daemon3. Defaults to true. diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml index 4f664f43e..6a9fd9d85 100644 --- a/man/systemd.journal-fields.xml +++ b/man/systemd.journal-fields.xml @@ -362,7 +362,7 @@ systemd1, journalctl1, journald.conf5, - sd-journal7 + sd-journal3 diff --git a/man/systemd.xml b/man/systemd.xml index 9ff6495e5..a184b1a40 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -1244,7 +1244,7 @@ systemadm1, systemd-notify1, daemon7, - sd-daemon7, + sd-daemon3, systemd.unit5, systemd.special5, pkg-config1, diff --git a/src/systemd/sd-daemon.h b/src/systemd/sd-daemon.h index fe51159ee..b204e317b 100644 --- a/src/systemd/sd-daemon.h +++ b/src/systemd/sd-daemon.h @@ -64,7 +64,7 @@ extern "C" { This should compile on non-Linux systems, too, but with the exception of the sd_is_xxx() calls all functions will become NOPs. - See sd-daemon(7) for more information. + See sd-daemon(3) for more information. */ #ifndef _sd_printf_attr_ diff --git a/src/systemd/sd-id128.h b/src/systemd/sd-id128.h index 30cb68655..7d5e6c440 100644 --- a/src/systemd/sd-id128.h +++ b/src/systemd/sd-id128.h @@ -30,6 +30,8 @@ extern "C" { #endif +/* 128 Bit ID APIs. See sd-id128(3) for more information. */ + typedef union sd_id128 sd_id128_t; union sd_id128 { diff --git a/src/systemd/sd-journal.h b/src/systemd/sd-journal.h index 74e57f48e..cf1b8db74 100644 --- a/src/systemd/sd-journal.h +++ b/src/systemd/sd-journal.h @@ -34,6 +34,8 @@ extern "C" { #endif +/* Journal APIs. See sd-journal(3) for more information. */ + /* Write to daemon */ int sd_journal_print(int priority, const char *format, ...) __attribute__ ((format (printf, 2, 3))); int sd_journal_printv(int priority, const char *format, va_list ap); diff --git a/src/systemd/sd-login.h b/src/systemd/sd-login.h index 1a36a56b1..6bd1f2da4 100644 --- a/src/systemd/sd-login.h +++ b/src/systemd/sd-login.h @@ -44,6 +44,8 @@ extern "C" { * These functions access data in /proc, /sys/fs/cgroup and /run. All * of these are virtual file systems, hence the accesses are * relatively cheap. + * + * See sd-login(3) for more information. */ /* Get session from PID. Note that 'shared' processes of a user are diff --git a/src/systemd/sd-readahead.h b/src/systemd/sd-readahead.h index 1f8c5a0ca..2dac104f7 100644 --- a/src/systemd/sd-readahead.h +++ b/src/systemd/sd-readahead.h @@ -53,7 +53,7 @@ extern "C" { This should compile on non-Linux systems, too, but all functions will become NOPs. - See sd-readahead(7) for more information. + See sd-readahead(3) for more information. */ /* -- 2.30.2