summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README26
-rw-r--r--README.md82
-rw-r--r--boomange.1138
-rw-r--r--boomange.cabal12
4 files changed, 167 insertions, 91 deletions
diff --git a/README b/README
deleted file mode 100644
index 26675eb..0000000
--- a/README
+++ /dev/null
@@ -1,26 +0,0 @@
-A Bookmarks Manager with an HTML Generator.
-It depends on two of my libraries, Simtreelo and DescriLo, which may be obtained at Hackage or:
-
-mgmillani@hub.darcs.net:mgmillani/DescriLo
-mgmillani@hub.darcs.net:mgmillani/Simtreelo
-
-######
-
-When executed, boomange tries to find the system default configuration directory, using the following priority:
-1 - $XDG_CONFIG_HOME/boomange
-2 - $HOME/.config/boomange
-3 - Haskell's getAppUserDataDirectory boomange
-
-It then checks if the directory exists. If it does, it loads the 'config' file that must be there.
-If it does not exists, boomange creates the folder, together with a sample configuration, including a .css file and examples of bookmarks.
-
-######
-
-The config file contains 2 descriptions:
-
-config - configuration of what boomange should do. The possible values inside are:
- output - where the HTML should be placed after generation
- headerFile - file that will be prepended to output
- footerFile - file that will be appended to output
-
-watch - all files that should be watched for bookmarks. The left part of every value is irrelevant, and the right part indicates which file should be read. Each file should be a simtree (which is loaded by SimtreeLo), and all leaves are treated as the URL of their parent, which means that no parent should have more than 1 leaf as its children.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1787022
--- /dev/null
+++ b/README.md
@@ -0,0 +1,82 @@
+## Compiling
+
+Install `ghc` and `cabal`. Then run
+
+ cabal update
+ cabal sandbox init
+ cabal install --dependencies-only
+ cabal build
+
+This will generate the binary `boomange` in `dist/build/boomange/`.
+
+# Synopsis
+
+ boomange [OPTIONS...]
+
+# 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.
+
+# Features
+
+ - HTML generation, with custom header, footer and css style.
+ - Bookmarks are stored in human-readable text files.
+
+# Options
+
+ **`-a, --add <location> <URI>`**
+
+ Add 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.
+
+ Example: boomange --add 'id/desired/path' 'http://en.wikipedia.org/'
+
+ **`-c, --config <file>`**
+
+ Use `file` as configuration file instead of the default one (see below).
+
+ **`-h, --help`**
+
+ Show help.
+
+ **`-s, --status`**
+
+ Output configuration files info and exit.
+
+ **`-v, --version`**
+
+ Print version and exit.
+
+# Files
+
+boomange stores its configuration files in one of these directories by default:
+
+ - $XDG_CONFIG_HOME/boomange
+
+ - $HOME/.config/boomange
+
+ - 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 sections:
+
+
+ - config -- configuration of what boomange should do. The possible values inside are:
+
+ - output -- where the HTML should be placed after generation
+
+ - headerFile -- file that will be prepended to output
+
+ - footerFile -- file that will be appended to output
+
+ - 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.
+
+# Bugs
+
+No known bugs.
+
+# Author
+
+Marcelo Garlet Millani (marcelogmillani@gmail.com)
diff --git a/boomange.1 b/boomange.1
index 29a3e8f..2a9813c 100644
--- a/boomange.1
+++ b/boomange.1
@@ -1,69 +1,89 @@
.\" Manpage for boomange.
.\" Contact marcelogmillani@gmail.com to correct errors or typos.
-.TH man 1 "2017.09.28" "0.1.3.5" "boomange man page"
+.TH boomange 1 "2018.12.08" "0.1.3.7" "pictikz 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
+boomange \- generate an HTML file with bookmarks
+.SH Synopsis
.PP
-\fB-c, --config \fIfile\fR\fR
-.RS
-uses \fIfile\fR as configuration file instead of the default one (see below)
-.RE
+boomange [OPTIONS\&...]
+.SH Description
.PP
-\fB-v, --version\fR
-.RS
-outputs version and exits
-.RE
+In order to allow a unified and customized bookmarks file among
+different browsers, boomange generates a HTML file with an user\[cq]s
+bookmarks, allowing customisations in the form of header and footer
+files.
+.SH Features
+.IP \[bu] 2
+HTML generation, with custom header, footer and css style.
+.IP \[bu] 2
+Bookmarks are stored in human\-readable text files.
+.SH Options
.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
+\f[B]\f[CB]\-a, \-\-add <location> <URI>\f[B]\f[R]
+.PP
+Add a bookmark to file with the given id.
+The depths of should be separated with \[cq]/\[cq]s.
+The id are the left\-side values inside the \[lq]watch\[rq] section in
+the config file.
+.PP
+Example: boomange \[en]add `id/desired/path' `http://en.wikipedia.org/'
+.PP
+\f[B]\f[CB]\-c, \-\-config <file>\f[B]\f[R]
+.PP
+Use \f[C]file\f[R] as configuration file instead of the default one (see
+below).
+.PP
+\f[B]\f[CB]\-h, \-\-help\f[B]\f[R]
+.PP
+Show help.
+.PP
+\f[B]\f[CB]\-s, \-\-status\f[B]\f[R]
+.PP
+Output configuration files info and exit.
+.PP
+\f[B]\f[CB]\-v, \-\-version\f[B]\f[R]
+.PP
+Print version and exit.
+.SH Files
+.PP
+boomange stores its configuration files in one of these directories by
+default:
+.IP \[bu] 2
$XDG_CONFIG_HOME/boomange
-.IP \(bu
+.IP \[bu] 2
$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
+.IP \[bu] 2
+Haskell\[cq]s System.Directory.getAppUserDataDirectory boomange
+.PP
+using the first solvable (i.e., the directory doesn\[cq]t have to exist,
+only the variable).
+If the directory does not exist, a sample configuration will be
+installed.
+.PP
+When executed, boomange searches for the config file inside the
+configuration folder, which uses descrilo syntax.
+It contains 2 sections:
+.IP \[bu] 2
+config \[en] configuration of what boomange should do.
+The possible values inside are:
+.RS 2
+.IP \[bu] 2
+output \[en] where the HTML should be placed after generation
+.IP \[bu] 2
+headerFile \[en] file that will be prepended to output
+.IP \[bu] 2
+footerFile \[en] 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
+.IP \[bu] 2
+watch \[en] 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 Bugs
+.PP
No known bugs.
-.SH AUTHOR
-Marcelo Garlet Millani (marcelogmillani@gmail.com)
+.SH Author
+.PP
+Marcelo Garlet Millani (marcelogmillani\[at]gmail.com)
diff --git a/boomange.cabal b/boomange.cabal
index 514f81c..4823862 100644
--- a/boomange.cabal
+++ b/boomange.cabal
@@ -2,30 +2,30 @@
-- documentation, see http://haskell.org/cabal/users-guide/
name: boomange
-version: 0.1.3.6
+version: 0.1.3.7
synopsis: A bookmarks manager with an HTML generator
description: In order to allow a unified and customized bookmarks file, boomange generates a HTML file with an user's bookmarks.
license: GPL-3
license-file: LICENSE
author: Marcelo Garlet Millani
maintainer: marcelogmillani@gmail.com
-copyright: (c) 2013-2017 Marcelo Garlet Millani
+copyright: (c) 2013-2018 Marcelo Garlet Millani
category: Web
build-type: Simple
data-files: html/footer.html, html/header.html, style.css
-extra-doc-files: README, boomange.1
+extra-doc-files: README.md, boomange.1
cabal-version: 1.18
executable boomange
main-is: Main.hs
-- other-modules:
-- other-extensions:
- build-depends: base >=4.8 && <4.12, directory >=1.2 && <1.4, filepath >=1.4 && <1.5, descrilo >=0.1 && <0.2, containers >=0.5 && <0.6, simtreelo >=0.1 && <0.2
+ build-depends: base >=4.8 && <5, directory >=1.2, filepath >=1.4, descrilo >=0.1, containers >=0.5, simtreelo >=0.1
-- hs-source-dirs:
other-modules: Data.Entities, Data.Loader, Data.Builder, Paths_boomange
default-extensions: DoAndIfThenElse
default-language: Haskell2010
source-repository head
- type: darcs
- location: http://hub.darcs.net/mgmillani/BooManGe
+ type: git
+ location: https://gitlab.com/mgmillani/boomange.git