apps/doc/konqueror/man-kbookmarkmerger.1.docbook

   1 <?xml version="1.0" ?>
   2 <!-- vim:set ts=4 noet syntax=xml: -->
   3 <!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
   4 <!ENTITY % English "INCLUDE">
   5 <!ENTITY kbookmarkmerger "<command>kbookmarkmerger</command>">
   6 ]>
   7
   8 <refentry lang="&language;">
   9 <refentryinfo>
  10         <title>KDE User's Manual</title>
  11         <author>
  12                 &Frerich.Raabe;
  13                 &Frerich.Raabe.mail;
  14         </author>
  15         <date>February 1st, 2005</date>
  16         <productname>K Desktop Environment</productname>
  17 </refentryinfo>
  18
  19 <refmeta>
  20         <refentrytitle>&kbookmarkmerger;</refentrytitle>
  21         <manvolnum>1</manvolnum>
  22 </refmeta>
  23
  24 <refnamediv>
  25         <refname>&kbookmarkmerger;</refname>
  26         <refpurpose>A program for merging a given set of bookmarks into the
  27         user's list of bookmarks.</refpurpose>
  28 </refnamediv>
  29
  30 <refsynopsisdiv>
  31 <cmdsynopsis>
  32         &kbookmarkmerger;
  33         <arg choice="opt" rep="repeat">Qt Options</arg>
  34         <arg choice="opt" rep="repeat">KDE Options</arg>
  35         <arg choice="req">directory</arg>
  36 </cmdsynopsis>
  37 </refsynopsisdiv>
  38
  39 <refsect1>
  40 <title>Description</title>
  41 <para>&kbookmarkmerger; is a program for merging a given set of bookmarks into
  42 the user's set of bookmarks; if the user doesn't have any bookmarks created
  43 yet, a new bookmark list is created and the given bookmarks are inserted into
  44 it. While doing this, &kbookmarkmerger; keeps track of which files were
  45 merged in a previous run already, so no bookmark will get installed to the
  46 user's bookmarks more than once. In case &kde; is running while
  47 &kbookmarkmerger; is executed, the &kde; bookmark subsystem will be informed
  48 of any changes to the user's bookmarks, so that all applications accessing
  49 that information (&ie; &konqueror;) will pick the changes up instantly.</para>
  50
  51 <para>The traditionally used approach to achieve something like this was to
  52 use carefully crafted skeleton home directories when creating a new user
  53 account, to provide the user with a standard set of bookmarks. The problem
  54 with this approach is that after the user account has been created, no new
  55 bookmarks can be propagated.</para>
  56
  57 <para>This mechanism is useful for system administrators who want to propagate
  58 a bookmark pointing to a certain document (for instance, important notes about
  59 the system) to all users. Distributors might find it useful as well, for
  60 instance by augmenting the software packages they supply with bookmark files
  61 which &kbookmarkmerger; merges into the user's bookmark list when the
  62 package is installed. That way, documentation shipped with a software package
  63 is easily and visibly accessible right after the package has been
  64 installed.</para>
  65
  66 <para>The only parameter required by &kbookmarkmerger; is the name of a
  67 directory which shall be scanned for bookmark files. All files in the given
  68 directory will be considered for being merged into the user's setup. The
  69 files in the given directory should be valid <acronym>XBEL</acronym>
  70 files.</para>
  71 </refsect1>
  72
  73 <refsect1>
  74 <title>See Also</title>
  75 <para><ulink url="help:/konqueror/index.html">&konqueror; manual</ulink></para>
  76 </refsect1>
  77
  78 <refsect1>
  79 <title>Examples</title>
  80 <screen>joe@hal9000:~> <command>kbookmarkmerger <filename>/usr/local/extra-bookmarks</filename></command></screen>
  81 <para>Merges all bookmark files stored in
  82 <filename>/usr/local/extra-bookmarks</filename> into joe's list of
  83 bookmarks.</para>
  84 </refsect1>
  85
  86 <refsect1>
  87 <title>Standards</title>
  88 <variablelist>
  89 <varlistentry><term/><listitem><para>
  90         <ulink url="http://pyxml.sourceforge.net/topics/xbel/"><acronym>XBEL</acronym> specification</ulink>
  91 </para></listitem></varlistentry>
  92 </variablelist>
  93 </refsect1>
  94
  95 <refsect1>
  96 <title>Restrictions</title>
  97 <para>When determining whether a given bookmark file has been merged into the
  98 user's bookmarks already or not, &kbookmarkmerger; merely looks at the
  99 filename of the bookmark file - the contents are not checked at all. This means
 100 that changing a bookmark file which was already merged into a user's bookmarks
 101 will not trigger merging it once again.</para>
 102
 103 <para>Also note that in case a user modifies a bookmark which was merged into
 104 his setup, the original bookmark file will be left unmodified.</para>
 105 </refsect1>
 106
 107 <refsect1>
 108 <title>Author</title>
 109 <para>&Frerich.Raabe; &Frerich.Raabe.mail;</para>
 110 </refsect1>
 111 </refentry>
 112