Bug 18323

Summary: Connection Manager parameter docs should be online
Product: Telepathy Reporter: Murray Cumming <murrayc>
Component: tp-glibAssignee: Telepathy bugs list <telepathy-bugs>
Status: RESOLVED MOVED QA Contact: Telepathy bugs list <telepathy-bugs>
Severity: normal    
Priority: medium    
Version: unspecified   
Hardware: Other   
OS: All   
Whiteboard:
i915 platform: i915 features:

Description Murray Cumming 2008-10-31 02:54:25 UTC
The set of parameters supported by the connection managers probably doesn't change that much. Introspecting is awkward, so it would be nice to have the list online.

An official command line utility, like gst-inspect, would also be useful.
Comment 1 Simon McVittie 2009-03-05 02:45:58 UTC
examples/client/telepathy-example-inspect-cm in telepathy-glib now does what you want - its output is not machine-readable, but I don't think that matters, since anyone wanting to inspect CMs programmatically should just use TpConnectionManager directly. The output for my versions of Gabble and Salut:

smcv@carbon% ./examples/client/telepathy-example-inspect-cm gabble
** Message: Connection manager name: gabble
** Message: Is running: no
** Message: Source of information: .manager file
** Message: Protocol: jabber
** Message: 	Can register accounts via Telepathy: yes
** Message: 	Parameter: account
** Message: 		D-Bus signature: s
** Message: 		Is required: yes
** Message: 		Is required for registration: yes
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		No default value
** Message: 	Parameter: password
** Message: 		D-Bus signature: s
** Message: 		Is required: yes
** Message: 		Is required for registration: yes
** Message: 		Is secret (password etc.): yes
** Message: 		Is a D-Bus property: no
** Message: 		No default value
** Message: 	Parameter: server
** Message: 		D-Bus signature: s
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		No default value
** Message: 	Parameter: resource
** Message: 		D-Bus signature: s
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		Default value: "Telepathy"
** Message: 	Parameter: priority
** Message: 		D-Bus signature: n
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		Default value: 0
** Message: 	Parameter: port
** Message: 		D-Bus signature: q
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		No default value
** Message: 	Parameter: old-ssl
** Message: 		D-Bus signature: b
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		Default value: FALSE
** Message: 	Parameter: require-encryption
** Message: 		D-Bus signature: b
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		Default value: FALSE
** Message: 	Parameter: register
** Message: 		D-Bus signature: b
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		Default value: FALSE
** Message: 	Parameter: low-bandwidth
** Message: 		D-Bus signature: b
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		Default value: FALSE
** Message: 	Parameter: https-proxy-server
** Message: 		D-Bus signature: s
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		No default value
** Message: 	Parameter: https-proxy-port
** Message: 		D-Bus signature: q
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		Default value: 443
** Message: 	Parameter: fallback-conference-server
** Message: 		D-Bus signature: s
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		No default value
** Message: 	Parameter: stun-server
** Message: 		D-Bus signature: s
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		No default value
** Message: 	Parameter: stun-port
** Message: 		D-Bus signature: q
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		Default value: 3478
** Message: 	Parameter: ignore-ssl-errors
** Message: 		D-Bus signature: b
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		Default value: FALSE
** Message: 	Parameter: alias
** Message: 		D-Bus signature: s
** Message: 		Is required: no
** Message: 		Is required for registration: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		No default value

smcv@carbon% ./examples/client/telepathy-example-inspect-cm salut
** Message: Connection manager name: salut
** Message: Is running: no
** Message: Source of information: .manager file
** Message: Protocol: local-xmpp
** Message:     Can register accounts via Telepathy: no
** Message:     Parameter: nickname
** Message:             D-Bus signature: s
** Message:             Is required: no
** Message:             Is secret (password etc.): no
** Message:             Is a D-Bus property: no
** Message:             No default value
** Message:     Parameter: first-name
** Message:             D-Bus signature: s
** Message:             Is required: yes
** Message:             Is secret (password etc.): no
** Message:             Is a D-Bus property: no
** Message:             No default value
** Message:     Parameter: last-name
** Message:             D-Bus signature: s
** Message:             Is required: yes
** Message:             Is secret (password etc.): no
** Message:             Is a D-Bus property: no
** Message: 		No default value
** Message: 	Parameter: jid
** Message: 		D-Bus signature: s
** Message: 		Is required: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		No default value
** Message: 	Parameter: email
** Message: 		D-Bus signature: s
** Message: 		Is required: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		No default value
** Message: 	Parameter: published-name
** Message: 		D-Bus signature: s
** Message: 		Is required: no
** Message: 		Is secret (password etc.): no
** Message: 		Is a D-Bus property: no
** Message: 		No default value

Connection manager parameter documentation can be put online in various ways. The simplest would be for wiki pages to link to the canonical source of the parameters in the CM's source code (which I'm about to change to be a blob of Python), or for the `make maintainer-upload-release` target to upload either the .manager file or a more human-readable version somewhere that the wiki can reference.
Comment 2 GitLab Migration User 2019-12-03 19:23:06 UTC
-- GitLab Migration Automatic Message --

This bug has been migrated to freedesktop.org's GitLab instance and has been closed from further activity.

You can subscribe and participate further through the new bug through this link to our GitLab instance: https://gitlab.freedesktop.org/telepathy/telepathy-glib/issues/9.

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.