From 8fb59400763db5a8d2b8933e4e77ad746447b6b3 Mon Sep 17 00:00:00 2001 From: Christian Linke Date: Thu, 16 Apr 2015 10:45:43 +0200 Subject: * updated documentation, fixed bug in generation of documentation, adopted README Signed-off-by: Christian Linke --- README | 67 +++++++++++++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 50 insertions(+), 17 deletions(-) (limited to 'README') diff --git a/README b/README index 2020626..30ed489 100755 --- a/README +++ b/README @@ -325,24 +325,57 @@ static const am_CustomSystemPropertyType_t SYP_UNKNOWN = 0; The commandline options of the AudioManager: ---- -AudioManagerDaemon Version: 3.0.11 -Usage: AudioManagerDaemon [options] -options: - -h: print this message - -i: info about current settings - -v: print version - -d: daemonize AudioManager - -T: DbusType to be used by CAmDbusWrapper (0=DBUS_SESSION[default], 1=DBUS_SYSTEM) - -p path for sqlite database (default is in memory) - -t port for telnetconnection - -m number of max telnetconnections - -c use controllerPlugin (full path with .so ending) - -l replace command plugin directory with (full path) - -r replace routing plugin directory with (full path) - -L add command plugin directory with (full path) - -R add routing plugin directory with (full path) ----- +USAGE: + + ./AudioManager [-K ] [-m ] [-t ] [-i] [-r ] + [-R ] [-l ] [-L ] [-c ] + [--] [--version] [-h] + + +Where: + + -K , --controllerPluginArg + a test argument for the controller + + -m , --maxConnections + Maximal number of connections for telnet + + -t , --telnetport + The port that is used for telnet + + -i, --currentSettings + print current settings and exit + + -r , --RoutingPluginDir + path for looking for routing plugins + -R , --additionalRoutingPluginDirs + additional path for looking for routing plugins, can be used after -r + option + + -l , --CommandPluginDir + path for looking for command plugins + + -L , --additionalCommandPluginDirs + additional path for looking for command plugins, can be used after -l + option + + -c , --controllerPlugin + use controllerPlugin full path with .so ending + + --, --ignore_rest + Ignores the rest of the labeled arguments following this flag. + + --version + Displays version information and exits. + + -h, --help + Displays usage information and exits. + + + The team of the AudioManager wishes you a nice day! +---- +To learn more about the commandline options, check the doxygen documentation. == Telnet Server The audiomanager has a build- in telnetserver that serves for debuggin purposes. -- cgit v1.2.1