audioc: Improve documentation of main().

[paraslash.git] / audioc.c

diff --git a/audioc.c b/audioc.c
index 0c0eea47985f7cd0343ea791709895b25c15d940..09b21ba95c73b976e753eac5da06ff5208ca16da 100644 (file)
--- a/audioc.c
+++ b/audioc.c
@@ -271,10 +271,11 @@ static char *configfile_exists(void)
  * \param argc Usual argument count.
  * \param argv Usual argument vector.
  *
  * \param argc Usual argument count.
  * \param argv Usual argument vector.
  *

- * It creates a temporary local socket in order to communicate with para_audiod.
- * Authentication consists in sending a ucred buffer that contains the user id.
+ * It connects to the "well-known" local socket to communicate with
+ * para_audiod. Authentication is performed by sending a ucred buffer
+ * containing the user id to the local socket.

  *
  *

- * Any output received through the local socket is sent to stdout.
+ * Any data received from the socket is written to stdout.

  *
  * \return EXIT_SUCCESS or EXIT_FAILURE.
  *
  *
  * \return EXIT_SUCCESS or EXIT_FAILURE.
  *