Warning, /utilities/keditbookmarks/doc/man-kbookmarkmerger.1.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!-- vim:set ts=4 noet syntax=xml: -->
0003 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN" "dtd/kdedbx45.dtd" [
0004 <!ENTITY % English "INCLUDE">
0005 <!ENTITY kbookmarkmerger "<command>kbookmarkmerger</command>">
0006 ]>
0008 <refentry lang="&language;">
0009 <refentryinfo>
0010         <title>kbookmarkmerger User's Manual</title>
0011         <author>
0012                 &Frerich.Raabe;
0013                 &Frerich.Raabe.mail;
0014         </author>
0015         <date>2016-11-07</date>
0016         <releaseinfo>Applications 16.12</releaseinfo>
0017         <productname>KDE Applications</productname>
0018 </refentryinfo>
0020 <refmeta>
0021         <refentrytitle>&kbookmarkmerger;</refentrytitle>
0022         <manvolnum>1</manvolnum>
0023 </refmeta>
0025 <refnamediv>
0026         <refname>&kbookmarkmerger;</refname>
0027         <refpurpose>A program for merging a given set of bookmarks into the
0028         user's list of bookmarks.</refpurpose>
0029 </refnamediv>
0031 <refsynopsisdiv>
0032 <cmdsynopsis>
0033         &kbookmarkmerger;
0034         <arg choice="req">directory</arg>
0035 </cmdsynopsis>
0036 </refsynopsisdiv>
0038 <refsect1>
0039 <title>Description</title>
0040 <para>&kbookmarkmerger; is a program for merging a given set of bookmarks into
0041 the user's set of bookmarks; if the user doesn't have any bookmarks created
0042 yet, a new bookmark list is created and the given bookmarks are inserted into
0043 it. While doing this, &kbookmarkmerger; keeps track of which files were
0044 merged in a previous run already, so no bookmark will get installed to the
0045 user's bookmarks more than once.<!--FIXME True in kf5? In case &kde; is running while
0046 &kbookmarkmerger; is executed, the &kde; bookmark subsystem will be informed
0047 of any changes to the user's bookmarks, so that all applications accessing
0048 that information (&ie; &konqueror;) will pick the changes up instantly.--></para>
0050 <para>The traditionally used approach to achieve something like this was to
0051 use carefully crafted skeleton home directories when creating a new user
0052 account, to provide the user with a standard set of bookmarks. The problem
0053 with this approach is that after the user account has been created, no new
0054 bookmarks can be propagated.</para>
0056 <para>This mechanism is useful for system administrators who want to propagate
0057 a bookmark pointing to a certain document (for instance, important notes about
0058 the system) to all users. Distributors might find it useful as well, for
0059 instance by augmenting the software packages they supply with bookmark files
0060 which &kbookmarkmerger; merges into the user's bookmark list when the
0061 package is installed. That way, documentation shipped with a software package
0062 is easily and visibly accessible right after the package has been
0063 installed.</para>
0065 <para>The only parameter required by &kbookmarkmerger; is the name of a
0066 directory which shall be scanned for bookmark files. All files in the given
0067 directory will be considered for being merged into the user's setup. The
0068 files in the given directory should be valid <acronym>XBEL</acronym>
0069 files.</para>
0070 </refsect1>
0072 <refsect1>
0073 <title>See Also</title>
0074 <simplelist>
0075 <member><ulink url="help:/konqueror/index.html">&konqueror; manual</ulink></member>
0076 <member>kf5options(7)</member>
0077 </simplelist>
0078 </refsect1>
0080 <refsect1>
0081 <title>Examples</title>
0082 <screen>joe@hal9000:~> <command>kbookmarkmerger <filename>/usr/local/extra-bookmarks</filename></command></screen>
0083 <para>Merges all bookmark files stored in
0084 <filename>/usr/local/extra-bookmarks</filename> into joe's list of
0085 bookmarks.</para>
0086 </refsect1>
0088 <refsect1>
0089 <title>Standards</title>
0090 <variablelist>
0091 <varlistentry><term/><listitem><para>
0092         <ulink url="http://pyxml.sourceforge.net/topics/xbel/"><acronym>XBEL</acronym> specification</ulink>
0093 </para></listitem></varlistentry>
0094 </variablelist>
0095 </refsect1>
0097 <refsect1>
0098 <title>Restrictions</title>
0099 <para>When determining whether a given bookmark file has been merged into the
0100 user's bookmarks already or not, &kbookmarkmerger; merely looks at the
0101 filename of the bookmark file - the contents are not checked at all. This means
0102 that changing a bookmark file which was already merged into a user's bookmarks
0103 will not trigger merging it once again.</para>
0105 <para>Also note that in case a user modifies a bookmark which was merged into
0106 his setup, the original bookmark file will be left unmodified.</para>
0107 </refsect1>
0109 <refsect1>
0110 <title>Author</title>
0111 <para>&Frerich.Raabe; &Frerich.Raabe.mail;</para>
0112 </refsect1>
0113 </refentry>