[telepathy-mission-control/master] Add simple man pages for mc-account-convert, mc-tool and mc-wait-for-name

[Simon McVittie]

---
 .gitignore                 |    1 +
 util/Makefile.am           |   12 +++
 util/mc-account-convert.1  |   17 ++++
 util/mc-tool.1             |  204 ++++++++++++++++++++++++++++++++++++++++++++
 util/mc-wait-for-name.1.in |   34 +++++++
 5 files changed, 268 insertions(+), 0 deletions(-)
 create mode 100644 util/mc-account-convert.1
 create mode 100644 util/mc-tool.1
 create mode 100644 util/mc-wait-for-name.1.in

diff --git a/.gitignore b/.gitignore
index b346dd0..b769af2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -84,3 +84,4 @@ test/twisted/tools/tmp-session-bus.conf
 /util/mc-account-convert
 /util/mc-tool
 /util/mc-wait-for-name
+/util/mc-wait-for-name.1
diff --git a/util/Makefile.am b/util/Makefile.am
index 6e1cb16..4b33deb 100644
--- a/util/Makefile.am
+++ b/util/Makefile.am
@@ -8,6 +8,16 @@ mc_tool_LDADD = $(TELEPATHY_LIBS) $(top_builddir)/libmcclient/libmcclient.la
 mc_wait_for_name_SOURCES = wait-for-name.c
 mc_wait_for_name_LDADD = $(TELEPATHY_LIBS)
 
+dist_man1_MANS = mc-tool.1
+
+man1_MANS = mc-wait-for-name.1
+
+EXTRA_DIST = $(man1_MANS:%=%.in)
+CLEANFILES = $(man1_MANS)
+
+mc-wait-for-name.1: mc-wait-for-name.1.in Makefile
+	sed -e 's![@]bindir[@]!@bindir@!g' < $< > $@
+
 if HAVE_GCONF
 
 bin_PROGRAMS += mc-account-convert
@@ -15,4 +25,6 @@ mc_account_convert_CPPFLAGS = $(GCONF_CFLAGS)
 mc_account_convert_SOURCES = mc-account-convert.c
 mc_account_convert_LDADD = $(GCONF_LIBS) $(TELEPATHY_LIBS) $(top_builddir)/libmcclient/libmcclient.la
 
+dist_man1_MANS += mc-account-convert.1
+
 endif
diff --git a/util/mc-account-convert.1 b/util/mc-account-convert.1
new file mode 100644
index 0000000..2b413c6
--- /dev/null
+++ b/util/mc-account-convert.1
@@ -0,0 +1,17 @@
+.TH MC-ACCOUNT-CONVERT "1" "July 2009" "Telepathy" "Utilities"
+\" Copyright © 2009 Collabora Ltd. <http://www.collabora.co.uk/>
+\" This document may be distributed under the same terms as
+\" telepathy-mission-control itself.
+.SH NAME
+mc-account-convert \- migrate Mission Control 4 accounts to Mission Control 5
+.SH SYNOPSIS
+.B mc-account-convert
+.SH DESCRIPTION
+.B mc-account-convert
+reads the current user's GConf configuration for accounts stored by
+Mission Control 4, and creates the corresponding accounts in Mission Control 5
+(or any compatible Telepathy
+.BR AccountManager ).
+The account manager is assumed to be running already.
+.SH OPTIONS
+There are no command-line options.
diff --git a/util/mc-tool.1 b/util/mc-tool.1
new file mode 100644
index 0000000..8f74c6d
--- /dev/null
+++ b/util/mc-tool.1
@@ -0,0 +1,204 @@
+.TH MC-TOOL "1" "July 2009" "Telepathy" "Utilities"
+\" Copyright © 2009 Collabora Ltd. <http://www.collabora.co.uk/>
+\" This document may be distributed under the same terms as
+\" telepathy-mission-control itself.
+.SH NAME
+mc-tool \- manipulate Mission Control accounts from the command line
+.SH SYNOPSIS
+
+.B mc-tool list
+.PP
+
+.B mc-tool add
+.I PROFILE
+.I DISPLAY-NAME
+.IR "" [ PARAMETER-SETTINGS ...]
+.PP
+
+.B mc-tool add
+.IR MANAGER / PROTOCOL " [" PARAMETER-SETTINGS ...]
+.PP
+
+.B mc-tool update
+.IR ACCOUNT " [" PARAMETER-SETTINGS ...]
+.PP
+
+.B mc-tool display
+.I ACCOUNT DISPLAY-NAME
+.PP
+
+.B mc-tool nick
+.I ACCOUNT NICKNAME
+.PP
+
+.B mc-tool icon
+.I ACCOUNT ICON
+.PP
+
+.B mc-tool show
+.I ACCOUNT
+.PP
+
+.B mc-tool get
+.I ACCOUNT
+.IR PARAMETER " [" PARAMETER ...]
+.PP
+
+.B mc-tool auto-presence
+.IR ACCOUNT " " STATUS " [" MESSAGE ]
+.PP
+
+.B mc-tool request
+.IR ACCOUNT " " STATUS " [" MESSAGE ]
+.PP
+
+.B mc-tool auto-connect
+.I ACCOUNT
+.BR on | off
+.PP
+
+.B mc-tool remove
+.I ACCOUNT
+.PP
+
+.SH DESCRIPTION
+
+.BR mc-tool 's
+usage depends on its first argument (the "command")
+
+.SS SPECIFYING ACCOUNTS
+Where an account name is needed, it may be given as a full object path
+(e.g.
+.BR /org/freedesktop/Telepathy/Account/gabble/jabber/example ),
+or as the unique account-specific suffix (e.g.
+.BR gabble/jabber/example ).
+
+.SS SPECIFYING PARAMETER SETTINGS
+Many commands take arguments that represent Telepathy connection manager
+parameters (see the Telepathy Specification for details of these). Each
+argument has the following form:
+.PP
+.IB TYPE : NAME = VALUE
+.PP
+where
+.I TYPE
+is either
+.BR int ", " uint ", " bool ", or "
+.BR string
+(other parameter types exist, but are currently unsupported by
+.BR mc-tool ),
+.I NAME
+is the name of the connection manager parameter (e.g.
+.BR account " or " password ),
+and
+.I VALUE
+is the parameter's value (with integers in decimal, and booleans as
+.BR 0 " or " 1 ).
+.PP
+The
+.B update
+command also accepts arguments of the form
+.BI clear: NAME
+which delete the named parameter from the account configuration.
+.SS LIST
+.B mc-tool list
+lists the available accounts.
+
+.SS ADD
+.B mc-tool add
+adds an account. The connection manager and protocol can either be given
+as the name of a Mission Control
+.IR profile ,
+(e.g.
+.BR gtalk ),
+or as a slash-separated connection manager name and protocol (e.g.
+.BR gabble/jabber ).
+
+.SS DISPLAY
+.B mc-tool display
+.I ACCOUNT DISPLAY-NAME
+sets the
+.B DisplayName
+property of
+.IR ACCOUNT " to " DISPLAY-NAME.
+
+.SS NICK
+.B mc-tool nick
+.I ACCOUNT NICKNAME
+sets the
+.B Nickname
+property of
+.IR ACCOUNT " to " NICKNAME .
+
+.SS ICON
+.B mc-tool icon
+.I ACCOUNT ICON
+sets the
+.B Icon
+property of
+.IR ACCOUNT " to " ICON .
+
+.SS SHOW
+.B mc-tool show
+.I ACCOUNT
+shows information about
+.IR ACCOUNT .
+
+.SS GET
+.B mc-tool get
+.I ACCOUNT
+.IR PARAMETER " [" PARAMETER ...]
+shows the values of the given parameters of
+.IR ACCOUNT .
+
+.SS ENABLE
+.B mc-tool enable
+.I ACCOUNT
+sets the
+.B Enabled
+property of
+.IR ACCOUNT " to"
+.BR True .
+
+.SS DISABLE
+.B mc-tool disable
+.I ACCOUNT
+sets the
+.B Enabled
+property of
+.IR ACCOUNT " to"
+.BR False .
+
+.SS AUTO-PRESENCE
+.B mc-tool auto-presence
+.IR ACCOUNT " " STATUS " [" MESSAGE ]
+sets the
+.B AutomaticPresence
+property of
+.IR ACCOUNT " to"
+.IR STATUS " with optional message " MESSAGE .
+
+.SS REQUEST
+.B mc-tool request
+.IR ACCOUNT " " STATUS " [" MESSAGE ]
+sets the
+.B RequestedPresence
+property of
+.IR ACCOUNT " to"
+.IR STATUS " with optional message " MESSAGE ;
+this is how you tell an account to connect or go offline, for example.
+
+.SS AUTO-CONNECT
+.B mc-tool auto-connect
+.I ACCOUNT
+.B on
+sets the
+.B ConnectAutomatically
+property of
+.IR ACCOUNT " to"
+.BR True .
+.B mc-tool auto-connect
+.I ACCOUNT
+.B off
+sets it to
+.BR False .
diff --git a/util/mc-wait-for-name.1.in b/util/mc-wait-for-name.1.in
new file mode 100644
index 0000000..c49f3b8
--- /dev/null
+++ b/util/mc-wait-for-name.1.in
@@ -0,0 +1,34 @@
+.TH MC-WAIT-FOR-NAME "1" "July 2009" "Telepathy" "Utilities"
+\" Copyright © 2009 Collabora Ltd. <http://www.collabora.co.uk/>
+\" This document may be distributed under the same terms as
+\" telepathy-mission-control itself.
+.SH NAME
+mc-wait-for-name \- run until a D-Bus name appears on the session bus
+.SH SYNOPSIS
+.B mc-wait-for-name
+.I WELL-KNOWN-NAME
+.PP
+.nf
+.B [D-BUS Service]
+.BI Name= org.freedesktop.Telepathy.Client.Something
+.BI Exec=@bindir@/mc-wait-for-name " org.freedesktop.Telepathy.Client.Something"
+.fi
+.SH DESCRIPTION
+.B mc-wait-for-name
+runs until a bus name appears, then exits successfully. This can be used as a
+service-activation helper for a bus name that is not directly activatable, but
+will be provided automatically (after a while) by the desktop session.
+.SH EXIT STATUS
+.TP
+0
+The bus name eventually appeared
+.TP
+Non-zero
+mc-wait-for-name was unable to connect to the session bus, or some other error
+occurred
+.SH OPTIONS
+There are no additional command-line options.
+.SH BUGS
+If the requested well-known bus name never appears, then
+.B mc-wait-for-name
+will only exit when the session bus terminates.
-- 
1.5.6.5