From 1982bb7fd42f7b6d95fbccb2d90bc8627e4612a6 Mon Sep 17 00:00:00 2001
From: Sean McNamara <smcnam@gmail.com>
Date: Wed, 7 Jan 2009 23:29:16 +0100
Subject: --check: Updated manpage slightly and pulseaudio --help slightly.

It's good for new users - I didn't know about the convention for
daemon checks to only bump the exit code until, say, a year after I
first installed Linux. Of course, we could also put an entire guide to
using Linux in our manpage, or tell users how to check the exit code
with $?, or how to get to the terminal, or an example script, ... (you
can see how this would quickly get out of control). So just a little
bit more hint should be good for now. John? Does this work for you?

Sean

Signed-off-by: Lennart Poettering <lennart@poettering.net>
---
 man/pulseaudio.1.xml.in | 6 ++++--
 src/daemon/cmdline.c    | 2 +-
 2 files changed, 5 insertions(+), 3 deletions(-)

diff --git a/man/pulseaudio.1.xml.in b/man/pulseaudio.1.xml.in
index df828242..8810e90c 100644
--- a/man/pulseaudio.1.xml.in
+++ b/man/pulseaudio.1.xml.in
@@ -72,7 +72,7 @@ USA.
     </option>
 
     <option>
-      <p><opt>--dump-resampe-methods</opt></p>
+      <p><opt>--dump-resample-methods</opt></p>
       <optdesc><p>List available audio resamplers.</p></optdesc>
     </option>
 
@@ -110,7 +110,9 @@ USA.
       <p><opt>--check</opt></p>
 
       <optdesc><p>Return 0 as return code when the PulseAudio daemon
-      is already running for the calling user.</p></optdesc>
+      is already running for the calling user, or non-zero
+      otherwise. Produces no output on the console except for errors
+      to stderr.</p></optdesc>
     </option>
 
 
diff --git a/src/daemon/cmdline.c b/src/daemon/cmdline.c
index fbd6dc32..3a42bbde 100644
--- a/src/daemon/cmdline.c
+++ b/src/daemon/cmdline.c
@@ -124,7 +124,7 @@ void pa_cmdline_help(const char *argv0) {
            "      --cleanup-shm                     Cleanup stale shared memory segments\n"
            "      --start                           Start the daemon if it is not running\n"
            "  -k  --kill                            Kill a running daemon\n"
-           "      --check                           Check for a running daemon\n\n"
+           "      --check                           Check for a running daemon (only returns exit code)\n\n"
 
            "OPTIONS:\n"
            "      --system[=BOOL]                   Run as system-wide instance\n"
-- 
cgit