From 6c23c9bf1c0403285115a72537b61576a2a69117 Mon Sep 17 00:00:00 2001 From: Frerich Raabe Date: Mon, 31 Jan 2005 22:42:12 +0000 Subject: [PATCH] - Starting a manpage for kbookmarkmerger, will needs to fix this up a bit. Not built yet. svn path=/trunk/kdebase/doc/konqueror/; revision=384762 --- doc/konqueror/man-kbookmarkmerger.1.docbook | 177 ++++++++++++++++++++ 1 file changed, 177 insertions(+) create mode 100644 doc/konqueror/man-kbookmarkmerger.1.docbook diff --git a/doc/konqueror/man-kbookmarkmerger.1.docbook b/doc/konqueror/man-kbookmarkmerger.1.docbook new file mode 100644 index 0000000000..ab5ee9feeb --- /dev/null +++ b/doc/konqueror/man-kbookmarkmerger.1.docbook @@ -0,0 +1,177 @@ + + + + + KBookmarkMerger"> + XBEL"> +]> + + + + KDE User's Manual + + FrerichRaabe +
raabe@kde.org
 + + 2005Frerich Raabe + January 31, 2005 + K Desktop Environment + + + + KBOOKMARKMERGER + 1 + + + + &kbookmarkmerger; + A program for merging a given set of bookmarks into the + user's list of bookmarks. + + + + + kbookmarkmerger + Qt-option + &kde;-option + directory + + + + +DESCRIPTION +&kbookmarkmerger; is a program for merging a given set of bookmarks into +the user's set of bookmarks; if the user doesn't have any bookmarks created +yet, a new bookmark list is created and the given bookmarks are inserted into +it. While doing this, &kbookmarkmerger; keeps track of which files were +merged in a previous run already, so no bookmark will get installed to the +user's bookmarks more than once. In case &kde; is running while +&kbookmarkmerger; is executed, the &kde; bookmark subsystem will be informed +of any changes to the user's bookmarks, so that all applications accessing +that information (&ie; &konqueror;) will pick the changes up instantly. + +The traditionally used approach to achieve something like this was to +use carefully crafted skeleton home directories when creating a new user +account, to provide the user with a standard set of bookmarks. The problem +with this approach is that after the user account has been created, no new +bookmarks can be propagated. + +This mechanism is useful for system administrators who want to propagate +a bookmark pointing to a certain document (for instance, important notes about +the system) to all users. Distributors might find it useful as well, for +instance by augmenting the software packages they supply with bookmark files +which &kbookmarkmerger; merges into the user's bookmark list when the +package is installed. That way, documentation shipped with a software package +is easily and visibly accessible right after the package has been +installed. + +The only parameter required by &kbookmarkmerger; is the name of a +directory which shall be scanned for bookmark files. All files in the given +directory will be considered for being merged into the user's setup. The +files in the given directory should be valid &XBEL; files. + + + +OPTIONS +This program follows the usual GNU command line syntax, with long options +starting with two dashes (--). A summary of the options +supported by &kbookmarkmerger; follows. + + +Generic Options + + + + Show author information. + + + + Show help about options specific to &kbookmarkmerger;. + + + + Show help about Qt specific options. + + + + Show help about &kde; specific options. + + + + Show help about all options. + + + + Show information about license terms under which &kbookmarkmerger; is distributed. + + + + + Show version information. + + + + + +Qt Options +None Qt specific options which &kbookmarkmerger; provides have any +effect since &kbookmarkmerger; is a console application and does not provide +any &GUI;. + + + +&kde; Options +Only the following &kde; specific parameters will show any effect when +running &kbookmarkmerger;, since it's a console application and hence does +not provide any &GUI;. + + + + + Use the &DCOP; server specified by server. + + + + Disable crash handler, generate core dumps. + + + + + + +EXAMPLES +joe@hal9000:~> kbookmarkmerger /usr/local/extra-bookmarks + +Merges all bookmark files stored in +/usr/local/extra-bookmarks into joe's list of bookmark. + + + + +NOTES +When determining whether a given bookmark file has been merged into the +user's bookmarks already or not, &kbookmarkmerger; merely looks at the +filename of the bookmark file - the contents are not checked at all. This means +that changing a bookmark file which was already merged into a user's bookmarks +will not trigger merging it once again. + +Also note that in case a user modifies a bookmark which was merged into +his setup, the original bookmark file will be left unmodified. + + + +SEE ALSO + + + &XBEL; specification + + + KEditBookmarks manual + + + &konqueror; manual + + + +