Permalink
Browse files

Add man pages for the tools

  • Loading branch information...
icefox committed Jul 4, 2009
1 parent aaabf86 commit 541eabce7b841b2dc70058eaceb7ba8a3470374d
@@ -17,3 +17,16 @@ MOC_DIR = $$PWD/.moc
OBJECTS_DIR = $$PWD/.obj
include(../../install.pri)
+
+!mac {
+unix {
+ INSTALLS += man man-compress
+
+ man.path = $$DATADIR/man/man1
+ man.files += data/arora-cacheinfo.1
+
+ man-compress.path = $$DATADIR/man/man1
+ man-compress.extra = "" "gzip -9 -f \$(INSTALL_ROOT)/$$DATADIR/man/man1/arora-cacheinfo.1" ""
+ man-compress.depends = install_man
+}
+}
@@ -0,0 +1,39 @@
+.TH ARORA-CACHEINFO "4" "July 2009"
+
+.SH NAME
+arora-cacheinfo - a tool for extracting files and metadata out of Arora cache files.
+
+.SH SYNOPSIS
+.B arora-cacheinfo [-o cachefile] [file | url]
+
+.SH DESCRIPTION
+.B Arora-cacheinfo
+is a tool for extracting files and displaying metadata out of an Arora cache files that are stored on the disk. Every cache file contains both the cached file (sometimes compressed) and metadata associated with it such as expiration date. Cache files names always include the md5sum of the url and passing a url to arora-cacheinfo.1 will automatically determine the correct matching cache file name.
+
+.SH OPTIONS
+.TP
+.B -o cachefile
+Write the cached file if it exists to \fBcachefile\fR
+.TP
+.B file
+Specify the file to read from.
+.TP
+.B url
+Specify the url from which to compute the file to read from.
+.TP
+
+.SH BUGS
+Please report bugs to \fIhttp://code.google.com/p/arora/issues/list\fR.
+
+.SH AUTHOR
+The author of arora-cacheinfo is Benjamin C. Meyer <ben@meyerhome.net>.
+.PP
+This manual page was written by Benjamin C. Meyer <ben@meyerhome.net>
+.PP
+Permission is granted to copy, distribute and/or modify this document under the
+terms of the
+GNU General Public License, Version 2 or any later version published by the Free
+Software Foundation.
+.PP
+On Debian systems, the complete text of the GNU General Public License can be
+found in /usr/share/common-licenses/GPL.
@@ -0,0 +1,33 @@
+.TH HTMLTOXBEL "4" "July 2009"
+
+.SH NAME
+htmlToXBel - a tool to convert bookmarks stored in the html format into the xbel format.
+
+.SH SYNOPSIS
+.B htmlToXBel [stdin|htmlfile] [stdout|-o outFile]
+
+.SH DESCRIPTION
+.B htmlToXBel
+is a tool to convert bookmarks stored in the html format into the xbel format. Many browser have the ability to export their bookmarks as a html file. htmlToXBel takes that file as an input and will output those bookmarks in the XML Bookmark Exchange Language (XBEL) format.
+
+.SH OPTIONS
+.TP
+.B -o outFile
+Write the resulting XBEL to the file \fBoutFile\fR
+.TP
+
+.SH BUGS
+Please report bugs to \fIhttp://code.google.com/p/arora/issues/list\fR.
+
+.SH AUTHOR
+The author of htmlToXBel is Benjamin C. Meyer <ben@meyerhome.net>.
+.PP
+This manual page was written by Benjamin C. Meyer <ben@meyerhome.net>
+.PP
+Permission is granted to copy, distribute and/or modify this document under the
+terms of the
+GNU General Public License, Version 2 or any later version published by the Free
+Software Foundation.
+.PP
+On Debian systems, the complete text of the GNU General Public License can be
+found in /usr/share/common-licenses/GPL.
@@ -20,3 +20,16 @@ RESOURCES += source.qrc
include(../../install.pri)
include(../../webkittrunk.pri)
+
+!mac {
+unix {
+ INSTALLS += man man-compress
+
+ man.path = $$DATADIR/man/man1
+ man.files += data/htmlToXBel.1
+
+ man-compress.path = $$DATADIR/man/man1
+ man-compress.extra = "" "gzip -9 -f \$(INSTALL_ROOT)/$$DATADIR/man/man1/htmlToXBel.1" ""
+ man-compress.depends = install_man
+}
+}
@@ -0,0 +1,27 @@
+.TH HTMLTOXBEL "4" "July 2009"
+
+.SH NAME
+arora-placesimport - a tool for importing browser history from Firefox 3 and up
+
+.SH SYNOPSIS
+.B arora-placesinfo ~/.mozilla/firefox/[profile-dir]/places.sqlite
+
+.SH DESCRIPTION
+.B htmlToXBel
+is a tool for importing browser history from Firefox 3 and up.
+
+.SH BUGS
+Please report bugs to \fIhttp://code.google.com/p/arora/issues/list\fR.
+
+.SH AUTHOR
+The author of htmlToXBel is Benjamin C. Meyer <ben@meyerhome.net>.
+.PP
+This manual page was written by Benjamin C. Meyer <ben@meyerhome.net>
+.PP
+Permission is granted to copy, distribute and/or modify this document under the
+terms of the
+GNU General Public License, Version 2 or any later version published by the Free
+Software Foundation.
+.PP
+On Debian systems, the complete text of the GNU General Public License can be
+found in /usr/share/common-licenses/GPL.
@@ -15,3 +15,16 @@ include(../../install.pri)
# This can be improved to just include the history manager and utility classes
# once the history classes are separated out into individual files.
include(../../src/src.pri)
+
+!mac {
+unix {
+ INSTALLS += man man-compress
+
+ man.path = $$DATADIR/man/man1
+ man.files += data/arora-placesimport.1
+
+ man-compress.path = $$DATADIR/man/man1
+ man-compress.extra = "" "gzip -9 -f \$(INSTALL_ROOT)/$$DATADIR/man/man1/arora-placesimport.1" ""
+ man-compress.depends = install_man
+}
+}

0 comments on commit 541eabc

Please sign in to comment.