From c25651057038c6ef4f8cbd6819aa0b5ed892087a Mon Sep 17 00:00:00 2001
From: Roy Marples <roy@marples.name>
Date: Mon, 7 Jan 2008 12:39:27 +0000
Subject: add rc_getline to the man page

---
 man/rc_config.3 | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

(limited to 'man')

diff --git a/man/rc_config.3 b/man/rc_config.3
index 0e26e9c..054e764 100644
--- a/man/rc_config.3
+++ b/man/rc_config.3
@@ -22,16 +22,17 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd Dec 24, 2007
+.Dd Jan 08, 2008
 .Dt RC_CONFIG 3 SMM
 .Os OpenRC
 .Sh NAME
-.Nm rc_config_list , rc_config_load , rc_config_value , rc_yesno
+.Nm rc_getline , rc_config_list , rc_config_load , rc_config_value , rc_yesno
 .Nd functions to query OpenRC service configurations
 .Sh LIBRARY
 Run Command library (librc, -lrc)
 .Sh SYNOPSIS
 .In rc.h
+.Ft "char *" Fn rc_getline "FILE *fp"
 .Ft "char **" Fn rc_config_list "const char *file"
 .Ft "char **" Fn rc_config_load "const char *file"
 .Ft "char *" Fn rc_config_value "const char *const *list" "const char *entry"
@@ -39,6 +40,14 @@ Run Command library (librc, -lrc)
 .Sh DESCRIPTION
 These functions provide an easy means of querying OpenRC configuration files.
 .Pp
+.Fn rc_getline
+expands it's buffer using
+.Fn malloc
+until it has read a whole line from the file or EOF.
+Trailing newlines are removed and the buffer is returned. Any functions that
+read from files should use this function to avoid any potential overflows and
+to ensure that arbitary long lines are read.
+.Pp
 .Fn rc_config_list
 returns a list of non comment lines in
 .Fa file .
@@ -66,6 +75,7 @@ is also not false, no, off or 0 regardless of case then
 is set to
 .Va EINVAL .
 .Sh SEE ALSO
+.Xr malloc 3 ,
 .Xr rc_strlist_free 3 ,
 .Xr sh 1
 .Sh AUTHORS
-- 
cgit v1.2.3