572a44
From 5b154beab0557c51f18012e7d01d29d48d1910f3 Mon Sep 17 00:00:00 2001
572a44
From: Lennart Poettering <lennart@poettering.net>
572a44
Date: Thu, 7 Nov 2013 17:51:09 +0100
572a44
Subject: [PATCH] man: add docs for sd_is_special() and some man page symlinks
572a44
572a44
Conflicts:
572a44
	Makefile.am
572a44
---
572a44
 Makefile-man.am            | 15 +++++++++++++++
572a44
 man/sd_is_fifo.xml         | 17 +++++++++++++++++
572a44
 man/sd_seat_get_active.xml |  2 ++
572a44
 3 files changed, 34 insertions(+)
572a44
572a44
diff --git a/Makefile-man.am b/Makefile-man.am
572a44
index c8a4342..b8c8acc 100644
572a44
--- a/Makefile-man.am
572a44
+++ b/Makefile-man.am
572a44
@@ -138,6 +138,7 @@ MANPAGES_ALIAS += \
572a44
 	man/sd_is_socket.3 \
572a44
 	man/sd_is_socket_inet.3 \
572a44
 	man/sd_is_socket_unix.3 \
572a44
+	man/sd_is_special.3 \
572a44
 	man/sd_journal.3 \
572a44
 	man/sd_journal_add_conjunction.3 \
572a44
 	man/sd_journal_add_disjunction.3 \
572a44
@@ -238,6 +239,7 @@ man/sd_is_mq.3: man/sd_is_fifo.3
572a44
 man/sd_is_socket.3: man/sd_is_fifo.3
572a44
 man/sd_is_socket_inet.3: man/sd_is_fifo.3
572a44
 man/sd_is_socket_unix.3: man/sd_is_fifo.3
572a44
+man/sd_is_special.3: man/sd_is_fifo.3
572a44
 man/sd_journal.3: man/sd_journal_open.3
572a44
 man/sd_journal_add_conjunction.3: man/sd_journal_add_match.3
572a44
 man/sd_journal_add_disjunction.3: man/sd_journal_add_match.3
572a44
@@ -410,6 +412,9 @@ man/sd_is_socket_inet.html: man/sd_is_fifo.html
572a44
 man/sd_is_socket_unix.html: man/sd_is_fifo.html
572a44
 	$(html-alias)
572a44
 
572a44
+man/sd_is_special.html: man/sd_is_fifo.html
572a44
+	$(html-alias)
572a44
+
572a44
 man/sd_journal.html: man/sd_journal_open.html
572a44
 	$(html-alias)
572a44
 
572a44
@@ -844,7 +849,9 @@ MANPAGES_ALIAS += \
572a44
 	man/sd_pid_get_slice.3 \
572a44
 	man/sd_pid_get_unit.3 \
572a44
 	man/sd_pid_get_user_unit.3 \
572a44
+	man/sd_seat_can_graphical.3 \
572a44
 	man/sd_seat_can_multi_session.3 \
572a44
+	man/sd_seat_can_tty.3 \
572a44
 	man/sd_seat_get_sessions.3 \
572a44
 	man/sd_session_get_class.3 \
572a44
 	man/sd_session_get_display.3 \
572a44
@@ -873,7 +880,9 @@ man/sd_pid_get_owner_uid.3: man/sd_pid_get_session.3
572a44
 man/sd_pid_get_slice.3: man/sd_pid_get_session.3
572a44
 man/sd_pid_get_unit.3: man/sd_pid_get_session.3
572a44
 man/sd_pid_get_user_unit.3: man/sd_pid_get_session.3
572a44
+man/sd_seat_can_graphical.3: man/sd_seat_get_active.3
572a44
 man/sd_seat_can_multi_session.3: man/sd_seat_get_active.3
572a44
+man/sd_seat_can_tty.3: man/sd_seat_get_active.3
572a44
 man/sd_seat_get_sessions.3: man/sd_seat_get_active.3
572a44
 man/sd_session_get_class.3: man/sd_session_is_active.3
572a44
 man/sd_session_get_display.3: man/sd_session_is_active.3
572a44
@@ -930,9 +939,15 @@ man/sd_pid_get_unit.html: man/sd_pid_get_session.html
572a44
 man/sd_pid_get_user_unit.html: man/sd_pid_get_session.html
572a44
 	$(html-alias)
572a44
 
572a44
+man/sd_seat_can_graphical.html: man/sd_seat_get_active.html
572a44
+	$(html-alias)
572a44
+
572a44
 man/sd_seat_can_multi_session.html: man/sd_seat_get_active.html
572a44
 	$(html-alias)
572a44
 
572a44
+man/sd_seat_can_tty.html: man/sd_seat_get_active.html
572a44
+	$(html-alias)
572a44
+
572a44
 man/sd_seat_get_sessions.html: man/sd_seat_get_active.html
572a44
 	$(html-alias)
572a44
 
572a44
diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml
572a44
index 2bc860c..4d9cd79 100644
572a44
--- a/man/sd_is_fifo.xml
572a44
+++ b/man/sd_is_fifo.xml
572a44
@@ -48,6 +48,7 @@
572a44
                 <refname>sd_is_socket_inet</refname>
572a44
                 <refname>sd_is_socket_unix</refname>
572a44
                 <refname>sd_is_mq</refname>
572a44
+                <refname>sd_is_special</refname>
572a44
                 <refpurpose>Check the type of a file descriptor</refpurpose>
572a44
         </refnamediv>
572a44
 
572a44
@@ -93,6 +94,12 @@
572a44
                                 <paramdef>const char *<parameter>path</parameter></paramdef>
572a44
                         </funcprototype>
572a44
 
572a44
+                        <funcprototype>
572a44
+                                <funcdef>int <function>sd_is_special</function></funcdef>
572a44
+                                <paramdef>int <parameter>fd</parameter></paramdef>
572a44
+                                <paramdef>const char *<parameter>path</parameter></paramdef>
572a44
+                        </funcprototype>
572a44
+
572a44
                 </funcsynopsis>
572a44
         </refsynopsisdiv>
572a44
 
572a44
@@ -153,6 +160,16 @@
572a44
                 <parameter>path</parameter> parameter is not
572a44
                 <constant>NULL</constant>, it is checked whether the
572a44
                 message queue is bound to the specified name.</para>
572a44
+
572a44
+                <para><function>sd_is_special()</function> may be
572a44
+                called to check whether the specified file descriptor
572a44
+                refers to a special file. If the
572a44
+                <parameter>path</parameter> parameter is not
572a44
+                <constant>NULL</constant>, it is checked whether file
572a44
+                descriptor is bound to the specified file
572a44
+                name. Special files in this context are character
572a44
+                device nodes and files in <filename>/proc</filename>
572a44
+                or <filename>/sys</filename>.</para>
572a44
         </refsect1>
572a44
 
572a44
         <refsect1>
572a44
diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml
572a44
index 1610d3e..cd87696 100644
572a44
--- a/man/sd_seat_get_active.xml
572a44
+++ b/man/sd_seat_get_active.xml
572a44
@@ -46,6 +46,8 @@
572a44
                 <refname>sd_seat_get_active</refname>
572a44
                 <refname>sd_seat_get_sessions</refname>
572a44
                 <refname>sd_seat_can_multi_session</refname>
572a44
+                <refname>sd_seat_can_tty</refname>
572a44
+                <refname>sd_seat_can_graphical</refname>
572a44
                 <refpurpose>Determine state of a specific seat</refpurpose>
572a44
         </refnamediv>
572a44