.\" Manpage for boomange.
.\" Contact marcelogmillani@gmail.com to correct errors or typos.
.TH man 1 "19 Apr 2015" "0.1.3.0" "boomange man page"
.SH NAME
boomange \- generates an HTML file with bookmarks
.SH SYNOPSIS
boomange
.SH DESCRIPTION
In order to allow a unified and customized bookmarks file among different browsers, boomange generates a HTML file with an user's bookmarks, allowing customisations in the form of header and footer files.
.SH OPTIONS
.PP
\fB-h, --help\fR
.RS
shows help
.RE
.PP
\fB-c, --config \fIfile\fR\fR
.RS
uses \fIfile\fR as configuration file instead of the default one (see below)
.RE
.PP
\fB-v, --version\fR
.RS
outputs version and exits
.RE
.PP
\fB-s, --status\fR
.RS
outputs configuration files info and exits
.RE
\fB-a, --add <location> <URI>\fR
.RS
adds a bookmark to file with the given id. The depths of <location> should be separated with '/'s. The id are the left-side values inside the "watch" section in the config file.
.RE
.RS
Example: boomange --add 'id/desired/path' 'http://en.wikipedia.org/'
.RE
.SH FILES
boomange stores its configuration files in one of these directories by default:

.IP	\(bu 2 
$XDG_CONFIG_HOME/boomange
.IP \(bu
$HOME/.config/boomange
.IP \(bu
Haskell's System.Directory.getAppUserDataDirectory boomange

using the first solvable (i.e., the directory doesn't have to exist, only the variable). If the directory does not exist, a sample configuration will be installed.

When executed, boomange searches for the config file inside the configuration folder, which uses descrilo syntax. It contains 2 descriptions:

.IP	\(bu 
config \- configuration of what boomange should do. The possible values inside are:
.RS
.IP \(bu 2
output \- where the HTML should be placed after generation
.IP \(bu
headerFile \- file that will be prepended to output
.IP \(bu
footerFile \- file that will be appended to output
.RE
.IP \(bu 2
watch \- all files that should be read for bookmarks. The left part of every value is irrelevant, and the right part indicates the file. Each file should use simtreelo syntax, and all leaves are used as  URI for their parents, which means that a node with a leaf as child should have no other children.
.SH SEE ALSO
\fBdescrilo\fR(5), \fBsimtreelo\fR(5)
.SH BUGS
No known bugs.
.SH AUTHOR
Marcelo Garlet Millani (marcelogmillani@gmail.com)