summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2012-06-27Still recommend --exit-with-session in documentation, --exit-with-x11 was ↵Simon McVittie1-4/+4
reverted
2012-06-27Revert "dbus-launch: add --exit-with-x11 option"Simon McVittie1-20/+6
This reverts commit fcc656d430f53ad62c25e41d7e7bd880cbb726a0.
2012-06-15Document that dbus-launch is not dbus-run-sessionSimon McVittie1-0/+13
Architectural assumptions inside dbus-launch mean that it is unsuitable for use in contexts where a particular process's lifetime defines the session, unless there is an out-of-band mechanism (like the X server) which can signal the end of the session. Reviewed-by: Will Thompson <will.thompson@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39197
2012-06-15dbus-launch: revise recommendations and put them in an EXAMPLES sectionSimon McVittie1-17/+32
The first thing we should talk about is how to get a D-Bus session in your X session - that's the common case. Secondarily, we can tell command-line addicts how to have a D-Bus session. Do not recommend --exit-with-session here, since that polls (and reads from) stdin, which is harmful to precisely those command-line users! Until we have some better tool, the best we can do here is note that the dbus-daemon is not automatically terminated. Reviewed-by: Will Thompson <will.thompson@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39197
2012-06-15dbus-launch: add --exit-with-x11 optionSimon McVittie1-6/+20
This is more suitable for distributions' Xsession scripts: it verifies that X is already available, and so never results in an attempt to poll stdin. Reviewed-by: Will Thompson <will.thompson@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39197
2012-06-05Fix distcheck with newer Doxygen: remove *.js, too, during uninstallSimon McVittie1-0/+1
2012-03-27Merge remote-tracking branch 'alban/own_prefix2'Simon McVittie1-0/+10
Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=46273
2012-03-22doc: update documentation with own_prefix policy rulesAlban Crequy1-0/+10
https://bugs.freedesktop.org/show_bug.cgi?id=46886
2012-03-12spec: document unixexec transportsLennart Poettering1-3/+64
This adds a specification text for the new unixexec: transport. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35230 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-03-12Fix spelling errors in dbus-launch(1)John Bradshaw1-2/+2
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=47076 Bug-Fedora: https://bugzilla.redhat.com/show_bug.cgi?id=675491 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-02-21Prepare 1.5.10Simon McVittie1-1/+10
2012-02-14dbus-send.1: document --reply-timeoutSimon McVittie1-0/+5
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=14005 Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-14dbus-send.1, dbus-send: document --print-reply=literal consistentlySimon McVittie1-2/+8
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=14005 Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-14dbus-send.1: use bold and italic type consistentlySimon McVittie1-15/+18
According to man-pages(7) * bold is for literal text, the name of the thing being documented, or the name of another man page * italic is for replaceable text, usually in all-caps * normal type (in the SYNOPSIS) is for special syntax like the [] indicating optional things Bug: https://bugs.freedesktop.org/show_bug.cgi?id=14005 Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-10spec: document systemd transportLennart Poettering1-2/+23
This adds a short section about the systemd transport to the specification. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35232 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-02-10Merge branch 'system-search-paths-21620'Simon McVittie1-1/+26
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=21620 Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-10Merge branch 'doc-search-paths-35306'Simon McVittie1-3/+19
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35306 Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-10Merge branch 'reversed-dns-37095'Simon McVittie1-25/+125
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=37095 Reviewed-by: Lennart Poettering <lennart@poettering.net>
2012-02-10bus: introduce --nopidfile switch to disable writing of PID filesLennart Poettering1-0/+4
When used with init systems such as systemd (where PID files are redundant) this allows us to disable PID files even if a path is configured for them in the normal bus configuration files. Make use of this new switch in the systemd unit file. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=45520 Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-02-08Merge branch 'dbus-1.4'Simon McVittie1-1/+1
Conflicts: NEWS
2012-02-08docs: correctly invoke man2htmlJack Nagel1-1/+1
man2html expects to find its input on stdin, so just passing the filename will cause it to hang waiting for input. [man2html 1.6g as shipped in Debian seems to be fine with files on the command line, but apparently other versions aren't? -smcv] Signed-off-by: Jack Nagel <jacknagel@gmail.com> Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk> Bug: https://bugs.freedesktop.org/show_bug.cgi?id=43875
2012-02-08Explicitly don't search XDG_DATA_DIRS for system services, and document itSimon McVittie1-1/+26
In practice, it never works, because the activation helper doesn't respect environment variables for security reasons. If you want to vary the search path, alter system.conf instead, to replace or augment <standard_system_servicedirs/> with your preferred search path. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=21620 Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-02-08spec: document how to install session .service filesSimon McVittie1-0/+9
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35306 Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2012-02-08spec: document the search path for session servicesSimon McVittie1-3/+10
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=35306
2012-01-04Revert all changes since a36d4918a6f646e085Simon McVittie1-461/+77
Someone seems to have merged part of master into 1.4. Again. Let's go back to the "last known good" point (the branch-point of some 1.4 branches I had locally), then we can cherry-pick the changes that should have gone in.
2011-09-21Merge branch 'dbus-1.4'Simon McVittie1-14/+25
Conflicts: NEWS
2011-09-21Fix maintainer-upload-docs target to work out-of-treeSimon McVittie1-14/+25
The STATIC_DOCS, DTDS and all dist_ files except XMLTO_OUTPUT are in the source tree. The XMLTO_OUTPUT and the man2html output are in the build tree, and the BONUS_FILES already have $(srcdir) in their names. Also change the rules that generate the dbus-docs directory so that if they fail, they leave behind a temporary directory, rather than leaving behind a dbus-docs directory that causes make to not run those rules if re-run; and change the rules to scp files to the server, to put a trailing "/" on paths, ensuring that the tarball won't be uploaded as "www" if the www directory doesn't already exist. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=41047 Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-08-15Merge branch 'dbus-1.4'Simon McVittie1-7/+7
2011-08-15Install diagrams in htmldirChris Mayo1-7/+7
diagram.png and diagram.svg are linked from dbus-tutorial.html but recent changes to doc/Makefile.am mean that if htmldir is set with configure they are installed such that the relative link from dbus-tutorial.html does not work. Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2011-07-29micro versionSimon McVittie1-2/+2
2011-07-29spec v0.18 and D-Bus 1.5.6Simon McVittie1-1/+8
2011-07-29spec: mention that buses may have a security policy, but leave it ↵Simon McVittie1-0/+8
implementation-specific Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450 Reviewed-by: Thiago Macieira <thiago@kde.org>
2011-07-29Move the explanation of message routing to the Message Routing section, ↵Simon McVittie1-52/+56
leaving behind a summary Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450 Reviewed-by: Thiago Macieira <thiago@kde.org>
2011-07-29Define eavesdropping, and document the eavesdrop matchSimon McVittie1-0/+60
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450 Reviewed-by: Thiago Macieira <thiago@kde.org>
2011-07-29spec: define unicast messages and broadcast signals, and explicitly allow ↵Simon McVittie1-3/+21
unicast signals I believe that the wording of the spec has always allowed unicast signals, but most bindings assume that signals are broadcasts, so it seems worth saying specifically that this feature exists and can be useful. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450 Reviewed-by: Thiago Macieira <thiago@kde.org>
2011-07-29spec: make the Match Rules section true againSimon McVittie1-8/+13
The spec previously claimed that only messages matching the client's match rules would be received. This is not actually true: messages listing a client as their DESTINATION are always delivered (security policy permitting). Bug: https://bugs.freedesktop.org/show_bug.cgi?id=39450 Reviewed-by: Thiago Macieira <thiago@kde.org>
2011-07-28Upgrade the type system into its own top-level section of the specSimon McVittie1-19/+30
The type system can be used independently, for instance in GVariant (although GVariant's binary encoding is in fact not the same). Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38252 Reviewed-by: Lennart Poettering <lennart@poettering.net>
2011-07-28Merge branch 'dbus-1.4'Simon McVittie6-217/+217
2011-07-28man pages: replace all unescaped hyphen/minus characters with \-Simon McVittie6-217/+217
In a man page, "-" officially means a typographical (Unicode) hyphen, which frequently breaks the ability to copy and paste code examples from a man page. "\-" means the ASCII hyphen/minus character. See <http://lintian.debian.org/tags/hyphen-used-as-minus-sign.html> for more details. Rather than trying to distinguish between hyphens, em-dashes and hyphen/minus, I just replaced all ambiguous hyphens with \- by applying this vim command repeatedly until it didn't find anything: %s/\(^\|[^\\]\)-/\1\\-/g Bug: https://bugs.freedesktop.org/show_bug.cgi?id=38284 Reviewed-by: Lennart Poettering <lennart@poettering.net>
2011-07-18Merge branch 'dbus-1.4' and update NEWS for masterSimon McVittie1-13/+21
Conflicts: NEWS
2011-07-18Uninstall the installed docsSimon McVittie1-0/+4
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156 Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18Install man2html output to $(htmldir)Simon McVittie1-1/+1
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156 Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18Install diagram.*, system-activation.txt to the $(docdir)Simon McVittie1-3/+6
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156 Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18Install xmlto output to $(htmldir) automaticallySimon McVittie1-9/+7
Also rename HTML_FILES to XMLTO_OUTPUT, as a more self-describing name: we have other HTML files which are not the output from xmlto. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156 Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-07-18Install dbus.devhelp to $(htmldir), not $(apidir), and remove it in cleanSimon McVittie1-1/+4
It needs to be in $(htmldir) so that its relative paths will work. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=36156 Reviewed-by: Will Thompson <will.thompson@collabora.co.uk>
2011-06-01Finalize D-Bus Spec 0.17, update lists of authorsSimon McVittie1-1/+28
2011-05-25fix verb-subject agreement in ObjectManager specSimon McVittie1-2/+2
2011-05-25Add org.freedesktop.DBus.ObjectManager interfaceDavid Zeuthen1-0/+108
The org.freedesktop.DBus.ObjectManager provides a standardized and efficient way of keeping one or more tree of objects synchronized between one server and several clients. Bug: https://bugs.freedesktop.org/show_bug.cgi?id=34869 Signed-off-by: David Zeuthen <davidz@redhat.com> Reviewed-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
2011-05-17Cross-reference from the glossary to interface names etc.Simon McVittie1-4/+13
2011-05-17Describe best practices for property names, and recommend against ↵Simon McVittie1-0/+16
dash-separated-words Related to <https://bugs.freedesktop.org/show_bug.cgi?id=20948> whose conclusion seemed to be that anything is allowed, but CamelCase is considerably more interoperable.