kbookmarkmerger(1) [centos man page]

KBOOKMARKMERGER 
						 KDE User's Manual						   KBOOKMARKMERGER

NAME

       kbookmarkmerger - A program for merging a given set of bookmarks into the user's list of bookmarks.

SYNOPSIS

       kbookmarkmerger [Qt Options...] [KDE Options...] {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 (i.e.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.

SEE ALSO

       Konqueror manual[1]

EXAMPLES

	   joe@hal9000:~> kbookmarkmerger /usr/local/extra-bookmarks

       Merges all bookmark files stored in /usr/local/extra-bookmarks into joe's list of bookmarks.

STANDARDS

	   XBEL specification[2]

RESTRICTIONS

       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.

AUTHOR

       Frerich Raabe<raabe@kde.org>

AUTHOR

       Frerich Raabe <raabe@kde.org>
	   Author.

NOTES

	1. Konqueror manual
	   help:/konqueror/index.html

	2. XBEL specification
	   http://pyxml.sourceforge.net/topics/xbel/

K Desktop Environment						February 1st, 2005						   KBOOKMARKMERGER

Glib::BookmarkFile(3pm) 				User Contributed Perl Documentation				   Glib::BookmarkFile(3pm)

NAME

       Glib::BookmarkFile -  Parser for bookmark files

SYNOPSIS

	 use Glib;

	 $date .= $_ while (<DATA>);

	 $b = Glib::BookmarkFile->new;
	 $b->load_from_data($data);
	 $uri = 'file:///some/path/to/a/file.txt';
	 if ($b->has_item($uri)) {
	       $title = $b->get_title($uri);
	       $desc  = $b->get_description($uri);

	       print "Bookmark for `$uri' ($title):
";
	       print "	$desc
";
	 }
	 0;

	 __DATA__
	 <?xml version="1.0" encoding="UTF-8"?>
	 <xbel version="1.0"
	       xmlns:bookmark="http://www.freedesktop.org/standards/desktop-bookmarks"
	       xmlns:mime="http://www.freedesktop.org/standards/shared-mime-info">
	   <bookmark href="file:///tmp/test-file.txt" added="2006-03-22T18:54:00Z" modified="2006-03-22T18:54:00Z" visited="2006-03-22T18:54:00Z">
	     <title>Test File</title>
	     <desc>Some test file</desc>
	     <info>
	       <metadata owner="http://freedesktop.org">
		 <mime:mime-type type="text/plain"/>
		 <bookmark:applications>
		   <bookmark:application name="Gedit" exec="gedit %u" timestamp="1143053640" count="1"/>
		 </bookmark:applications>
	       </metadata>
	     </info>
	   </bookmark>
	 </xbel>

DESCRIPTION

       Glib::BookmarkFile lets you parse, edit or create files containing lists of bookmarks to resources pointed to by URIs, with some meta-data
       bound to them, following the Desktop Bookmark Specification.  The recent files support inside GTK+ uses this type of files to store the
       list of recently used files.

       The syntax of bookmark files is described in detail in the Desktop Bookmarks Specification, here is a quick summary: bookmark files use a
       subclass of the XML Bookmark Exchange Language (XBEL) document format, defining meta-data such as the MIME type of the resource pointed by
       a bookmark, the list of applications that have registered the same URI and the visibility of the bookmark.

METHODS

   bookmarkfile = Glib::BookmarkFile->new
   $bookmark_file->add_application ($uri, $name, $exec)
       o   $uri (string)

       o   $name (string or undef)

       o   $exec (string or undef)

       Adds the application with $name and $exec to the list of applications that have registered a bookmark for $uri into $bookmark_file.

       Every bookmark inside a "Glib::BookmarkFile" must have at least an application registered.  Each application must provide a name, a command
       line useful for launching the bookmark, the number of times the bookmark has been registered by the application and the last time the
       application registered this bookmark.

       If $name is undef, the name of the application will be the same returned by Glib::get_application_name(); if $exec is undef, the command
       line will be a composition of the program name as returned by Glib::get_prgname() and the "%u" modifier, which will be expanded to the
       bookmark's URI.

       This function will automatically take care of updating the registrations count and timestamping in case an application with the same $name
       had already registered a bookmark for $uri inside the bookmark file.  If no bookmark for $uri is found one is created.

   $bookmark_file->add_group ($uri, $group)
       o   $uri (string)

       o   $group (string)

       Adds $group to the list of groups to which the bookmark for $uri belongs to.  If no bookmark for $uri is found one is created.

   unix timestamp = $bookmark_file->get_added ($uri)
       o   $uri (string)

   $bookmark_file->set_added ($uri, $value)
       o   $uri (string)

       o   $value (unix timestamp)

       Sets the time the bookmark for $uri was added.  If no bookmark for $uri is found one is created.

   ($exec, $count, $stamp) = $bookmark_file->get_app_info ($uri, $name)
       o   $uri (string)

       o   $name (string)

       Gets the registration information of $name for the bookmark for $uri.  See Glib::BookmarkFile::set_app_info() for more information about
       the returned data.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->set_app_info ($uri, $name, $exec, $count, $stamp)
       o   $uri (string)

       o   $name (string)

       o   $exec (string)

       o   $count (integer)

       o   $stamp (unix timestamp)

       Sets the meta-data of application $name inside the list of applications that have registered a bookmark for $uri inside $bookmark_file.

       You should rarely use this method; use Glib::BookmarkFile::add_application() and Glib::BookmarkFile::remove_application() instead.

       $name can be any UTF-8 encoded string used to identify an application.  $exec can have one of these two modifiers: "%f", which will be
       expanded as the local file name retrieved from the bookmark's URI; "%u", which will be expanded as the bookmark's URI. The expansion is
       done automatically when retrieving the stored command line using the Glib::BookmarkFile::get_app_info() method.	$count is the number of
       times the application has registered the bookmark; if it is < 0, the current registration count will be increased by one, if it is 0, the
       application with $name will be removed from the list of registered applications.  $stamp is the Unix time of the last registration, as
       returned by time(); if it is -1, the current time will be used.

       If you try to remove an application by setting its registration count to zero, and no bookmark for $uri is found, %FALSE is returned and an
       exception is fired.

       May croak with a Glib::Error in $@ on failure.

   list = $bookmark_file->get_applications ($uri)
       o   $uri (string)

       Retrieves the names of the applications that have registered the bookmark for $uri.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->get_description ($uri)
       o   $uri (string)

       Gets the description of the bookmark for $uri.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->set_description ($uri, $description)
       o   $uri (string)

       o   $description (string)

       Sets the description of the bookmark for $uri.  If no bookmark for $uri is found one is created.

   list = $bookmark_file->get_groups ($uri)
       o   $uri (string)

       Retrieves the list of group names of the bookmark for $uri.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->set_groups ($uri, ...)
       o   $uri (string)

       o   ... (list) one or more group names

       Sets a list of group names for the item with URI $uri.  Each previously set group name list is removed.	If no bookmark for $uri is found
       one is created.

   boolean = $bookmark_file->has_application ($uri, $name)
       o   $uri (string)

       o   $name (string)

       Checks whether the bookmark for $uri inside $bookmark_file has been registered by application $name.

       May croak with a Glib::Error in $@ on failure.

   boolean = $bookmark_file->has_group ($uri, $group)
       o   $uri (string)

       o   $group (string)

       Checks whether $group appears in the list of groups to which the bookmark for $uri belongs to.

       May croak with a Glib::Error in $@ on failure.

   boolean = $bookmark_file->has_item ($uri)
       o   $uri (string)

       Looks whether the bookmark file has a bookmark for $uri.

   ($href, $mime_type) = $bookmark_file->get_icon ($uri)
       o   $uri (string)

       Gets the icon of the bookmark for $uri.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->set_icon ($uri, $href, $mime_type)
       o   $uri (string)

       o   $href (string or undef)

       o   $mime_type (string or undef)

       Sets the icon for the bookmark for $uri.  If $href is undef, unsets the currently set icon.

   boolean = $bookmark_file->get_is_private ($uri)
       o   $uri (string)

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->set_is_private ($uri, $is_private)
       o   $uri (string)

       o   $is_private (boolean)

   $bookmark_file->load_from_data ($buf)
       o   $buf (scalar)

       Parses a string containing a bookmark file structure.

       May croak with a Glib::Error in $@ on failure.

   ($full_path) = $bookmark_file->load_from_data_dirs ($file)
       o   $file (localized file name)

       Parses a bookmark file, searching for it inside the data directories.  If a file is found, it returns the full path.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->load_from_file ($file)
       o   $file (localized file name)

       Parses a bookmark file.

       May croak with a Glib::Error in $@ on failure.

   string = $bookmark_file->get_mime_type ($uri)
       o   $uri (string)

       Gets the MIME type of the bookmark for $uri.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->set_mime_type ($uri, $mime_type)
       o   $uri (string)

       o   $mime_type (string)

       Sets the MIME type of the bookmark for $uri.  If no bookmark for $uri is found one is created.

   unix timestamp = $bookmark_file->get_modified ($uri)
       o   $uri (string)

   $bookmark_file->set_modified ($uri, $value)
       o   $uri (string)

       o   $value (unix timestamp)

       Sets the time the bookmark for $uri was last modified.  If no bookmark for $uri is found one is created.

   $bookmark_file->move_item ($old_uri, $new_uri)
       o   $old_uri (string)

       o   $new_uri (string or undef)

       Changes the URI of a bookmark item from $old_uri to $new_uri.  Any existing bookmark for $new_uri will be overwritten.  If $new_uri is
       undef, then the bookmark is removed.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->remove_application ($uri, $name)
       o   $uri (string)

       o   $name (string)

       Removes application registered with $name from the list of applications that have registered a bookmark for $uri inside $bookmark_file.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->remove_group ($uri, $group)
       o   $uri (string)

       o   $group (string)

       Removes $group from the list of groups to which the bookmark for $uri belongs to.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->remove_item ($uri)
       o   $uri (string)

       Removes the bookmark for $uri from the bookmark file.

       May croak with a Glib::Error in $@ on failure.

   integer = $bookmark_file->get_size
       Gets the number of bookmarks inside the bookmark file.

   $bookmark_file->get_title ($uri, $title)
       o   $uri (string)

       Gets the title of the bookmark for $uri.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->set_title ($uri, $title)
       o   $uri (string)

       o   $title (string)

       Sets the title of the bookmark for $uri.  If no bookmark for $uri is found one is created.

   string = $bookmark_file->to_data
       Returns the bookmark file as a string.

       May croak with a Glib::Error in $@ on failure.

   $bookmark_file->to_file ($file)
       o   $file (localized file name)

       Saves the contents of a bookmark file into a file.  The write operation is guaranteed to be atomical by writing the contents of the
       bookmark file to a temporary file and then moving the file to the target file.

       May croak with a Glib::Error in $@ on failure.

   list = $bookmark_file->get_uris
       Returns the URI of all the bookmarks in the bookmark file.

   unix timestamp = $bookmark_file->get_visited ($uri)
       o   $uri (string)

   $bookmark_file->set_visited ($uri, $value)
       o   $uri (string)

       o   $value (unix timestamp)

       Sets the time the bookmark for $uri was last visited.  If no bookmark for $uri is found one is created.

SEE ALSO

       Glib

COPYRIGHT

       Copyright (C) 2003-2011 by the gtk2-perl team.

       This software is licensed under the LGPL.  See Glib for a full notice.

perl v5.14.2							    2012-05-24						   Glib::BookmarkFile(3pm)