summaryrefslogtreecommitdiff
path: root/README.md
blob: 1787022f79f495b50e043c2dbf0f506f557e9441 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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)