From 7300f85caa0e6158eaf9ad972b488e2f58089a89 Mon Sep 17 00:00:00 2001 From: Michael Orlitzky Date: Tue, 7 Jan 2014 20:14:40 -0500 Subject: [PATCH] Update pidfile documentation. --- doc/htsnrc.example | 7 +++++-- doc/man1/htsn.1 | 6 ++++-- htsn.cabal | 6 ++++-- 3 files changed, 13 insertions(+), 6 deletions(-) diff --git a/doc/htsnrc.example b/doc/htsnrc.example index 90212cd..3a2347c 100644 --- a/doc/htsnrc.example +++ b/doc/htsnrc.example @@ -67,8 +67,11 @@ # (Daemon mode only) Create a PID file in the given location. This is # used by the init system on Unix to keep track of the running -# daemon. Its parent directory must be writable by the user/group that -# we will run as! +# daemon. +# +# If necessary, its parent directory will be created with owner/group +# set to the appropriate user/group, but at most one directory will be +# created (that is, we won't create an entire directory tree). # # Default: /run/htsn/htsn.pid # diff --git a/doc/man1/htsn.1 b/doc/man1/htsn.1 index 9d7ebce..8076e8d 100644 --- a/doc/man1/htsn.1 +++ b/doc/man1/htsn.1 @@ -99,8 +99,10 @@ Default: none .IP \fB\-\-pidfile\fR (Daemon mode only) Create a PID file in the given location. This is used by the init system on Unix to keep track of the running daemon. -Its parent directory must be writable by the user/group that we will -run as! + +If necessary, its parent directory will be created with owner/group +set to the appropriate user/group, but at most one directory will be +created (that is, we won't create an entire directory tree). Default: /run/htsn/htsn.pid diff --git a/htsn.cabal b/htsn.cabal index 5f2129d..fb82e5e 100644 --- a/htsn.cabal +++ b/htsn.cabal @@ -128,8 +128,10 @@ description: . (Daemon mode only) Create a PID file in the given location. This is used by the init system on Unix to keep track of the running daemon. - Its parent directory must be writable by the user/group that we will - run as! + . + If necessary, its parent directory will be created with owner/group + set to the appropriate user/group, but at most one directory will + be created (that is, we won't create an entire directory tree). . Default: \/run\/htsn\/htsn.pid . -- 2.43.2