From 26366664c140664f70d46772f0d1a790ec885410 Mon Sep 17 00:00:00 2001
From: Maarten Bosmans <mkbosmans@gmail.com>
Date: Fri, 18 Mar 2011 11:52:30 +0100
Subject: Update PA_MODULE_USAGE to be in line with actual implementation

---
 src/modules/alsa/module-alsa-sink.c                | 4 +++-
 src/modules/alsa/module-alsa-source.c              | 2 ++
 src/modules/bluetooth/module-bluetooth-proximity.c | 1 -
 src/modules/module-equalizer-sink.c                | 4 +++-
 src/modules/module-hal-detect.c                    | 4 ++--
 src/modules/module-pipe-sink.c                     | 2 +-
 src/modules/module-protocol-stub.c                 | 4 ++--
 src/modules/module-suspend-on-idle.c               | 1 +
 src/modules/module-waveout.c                       | 6 +++---
 9 files changed, 17 insertions(+), 11 deletions(-)

(limited to 'src/modules')

diff --git a/src/modules/alsa/module-alsa-sink.c b/src/modules/alsa/module-alsa-sink.c
index 697fab45..465c8b9e 100644
--- a/src/modules/alsa/module-alsa-sink.c
+++ b/src/modules/alsa/module-alsa-sink.c
@@ -40,7 +40,8 @@ PA_MODULE_LOAD_ONCE(FALSE);
 PA_MODULE_USAGE(
         "name=<name of the sink, to be prefixed> "
         "sink_name=<name for the sink> "
-        "sink_properities=<properties for the sink> "
+        "sink_properties=<properties for the sink> "
+        "namereg_fail=<pa_namereg_register() fail parameter value> "
         "device=<ALSA device> "
         "device_id=<ALSA card index> "
         "format=<sample format> "
@@ -64,6 +65,7 @@ static const char* const valid_modargs[] = {
     "name",
     "sink_name",
     "sink_properties",
+    "namereg_fail",
     "device",
     "device_id",
     "format",
diff --git a/src/modules/alsa/module-alsa-source.c b/src/modules/alsa/module-alsa-source.c
index 23da4185..90ffea57 100644
--- a/src/modules/alsa/module-alsa-source.c
+++ b/src/modules/alsa/module-alsa-source.c
@@ -65,6 +65,7 @@ PA_MODULE_USAGE(
         "name=<name for the source, to be prefixed> "
         "source_name=<name for the source> "
         "source_properties=<properties for the source> "
+        "namereg_fail=<pa_namereg_register() fail parameter value> "
         "device=<ALSA device> "
         "device_id=<ALSA card index> "
         "format=<sample format> "
@@ -84,6 +85,7 @@ static const char* const valid_modargs[] = {
     "name",
     "source_name",
     "source_properties",
+    "namereg_fail",
     "device",
     "device_id",
     "format",
diff --git a/src/modules/bluetooth/module-bluetooth-proximity.c b/src/modules/bluetooth/module-bluetooth-proximity.c
index 3eed9cea..8c3a5b9f 100644
--- a/src/modules/bluetooth/module-bluetooth-proximity.c
+++ b/src/modules/bluetooth/module-bluetooth-proximity.c
@@ -59,7 +59,6 @@ PA_MODULE_USAGE(
 
 static const char* const valid_modargs[] = {
     "sink",
-    "rssi",
     "hci",
     NULL,
 };
diff --git a/src/modules/module-equalizer-sink.c b/src/modules/module-equalizer-sink.c
index a28405b6..bb350c38 100644
--- a/src/modules/module-equalizer-sink.c
+++ b/src/modules/module-equalizer-sink.c
@@ -77,7 +77,8 @@ PA_MODULE_DESCRIPTION(_("General Purpose Equalizer"));
 PA_MODULE_VERSION(PACKAGE_VERSION);
 PA_MODULE_LOAD_ONCE(FALSE);
 PA_MODULE_USAGE(
-        _("sink_name=<name of the sink>"
+        _("sink_name=<name of the sink> "
+          "sink_properties=<properties for the sink> "
           "master=<sink to connect to> "
           "format=<sample format> "
           "rate=<sample rate> "
@@ -131,6 +132,7 @@ struct userdata {
 
 static const char* const valid_modargs[] = {
     "sink_name",
+    "sink_properties",
     "master",
     "format",
     "rate",
diff --git a/src/modules/module-hal-detect.c b/src/modules/module-hal-detect.c
index 23d40100..941ac3a4 100644
--- a/src/modules/module-hal-detect.c
+++ b/src/modules/module-hal-detect.c
@@ -57,13 +57,13 @@ PA_MODULE_VERSION(PACKAGE_VERSION);
 PA_MODULE_LOAD_ONCE(TRUE);
 #if defined(HAVE_ALSA) && defined(HAVE_OSS_OUTPUT)
 PA_MODULE_USAGE("api=<alsa or oss> "
-                "tsched=<enable system timer based scheduling mode?>"
+                "tsched=<enable system timer based scheduling mode?> "
                 "subdevices=<init all subdevices>");
 #elif defined(HAVE_ALSA)
 PA_MODULE_USAGE("api=<alsa> "
                 "tsched=<enable system timer based scheduling mode?>");
 #elif defined(HAVE_OSS_OUTPUT)
-PA_MODULE_USAGE("api=<oss>"
+PA_MODULE_USAGE("api=<oss> "
                 "subdevices=<init all subdevices>");
 #endif
 PA_MODULE_DEPRECATED("Please use module-udev-detect instead of module-hal-detect!");
diff --git a/src/modules/module-pipe-sink.c b/src/modules/module-pipe-sink.c
index b1158d38..6623aef4 100644
--- a/src/modules/module-pipe-sink.c
+++ b/src/modules/module-pipe-sink.c
@@ -61,7 +61,7 @@ PA_MODULE_USAGE(
         "sink_properties=<properties for the sink> "
         "file=<path of the FIFO> "
         "format=<sample format> "
-        "rate=<sample rate>"
+        "rate=<sample rate> "
         "channels=<number of channels> "
         "channel_map=<channel map>");
 
diff --git a/src/modules/module-protocol-stub.c b/src/modules/module-protocol-stub.c
index 7ba54054..1a14596c 100644
--- a/src/modules/module-protocol-stub.c
+++ b/src/modules/module-protocol-stub.c
@@ -137,7 +137,7 @@
   PA_MODULE_DESCRIPTION("Native protocol "SOCKET_DESCRIPTION);
   PA_MODULE_USAGE("auth-anonymous=<don't check for cookies?> "
                   "auth-cookie=<path to cookie file> "
-                  "auth-cookie-enabled=<enable cookie authentification? "
+                  "auth-cookie-enabled=<enable cookie authentification?> "
                   AUTH_USAGE
                   SOCKET_USAGE);
 #elif defined(USE_PROTOCOL_ESOUND)
@@ -166,7 +166,7 @@
                   "source=<source to connect to> "
                   "auth-anonymous=<don't verify cookies?> "
                   "auth-cookie=<path to cookie file> "
-                  "auth-cookie-enabled=<enable cookie authentification? "
+                  "auth-cookie-enabled=<enable cookie authentification?> "
                   AUTH_USAGE
                   SOCKET_USAGE);
 #else
diff --git a/src/modules/module-suspend-on-idle.c b/src/modules/module-suspend-on-idle.c
index cfb78792..2bc424b3 100644
--- a/src/modules/module-suspend-on-idle.c
+++ b/src/modules/module-suspend-on-idle.c
@@ -41,6 +41,7 @@ PA_MODULE_AUTHOR("Lennart Poettering");
 PA_MODULE_DESCRIPTION("When a sink/source is idle for too long, suspend it");
 PA_MODULE_VERSION(PACKAGE_VERSION);
 PA_MODULE_LOAD_ONCE(TRUE);
+PA_MODULE_USAGE("timeout=<timeout>");
 
 static const char* const valid_modargs[] = {
     "timeout",
diff --git a/src/modules/module-waveout.c b/src/modules/module-waveout.c
index 0dbf7ef9..1a3a6e18 100644
--- a/src/modules/module-waveout.c
+++ b/src/modules/module-waveout.c
@@ -55,11 +55,11 @@ PA_MODULE_USAGE(
     "record=<enable source?> "
     "playback=<enable sink?> "
     "format=<sample format> "
-    "channels=<number of channels> "
     "rate=<sample rate> "
+    "channels=<number of channels> "
+    "channel_map=<channel map> "
     "fragments=<number of fragments> "
-    "fragment_size=<fragment size> "
-    "channel_map=<channel map>");
+    "fragment_size=<fragment size>");
 
 #define DEFAULT_SINK_NAME "wave_output"
 #define DEFAULT_SOURCE_NAME "wave_input"
-- 
cgit