summaryrefslogtreecommitdiff
path: root/docs/_build/man/goboom.1
blob: d3d72ce93b903b775fc799424f20c76e4a21cb36 (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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
.\" Man page generated from reStructuredText.
.
.TH "GOBOOM" "1" "Mar 05, 2018" "0.2.2" "goboom"
.SH NAME
goboom \- a dmenu wrapper
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
goboom [option]

goobom_run
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
goboom is wrapper around the dmenu.
goboom is the successor and rewrite of xboomx in Go.
.sp
goboom sorts commands to launch according to their launch frequency.
In other words \- if you launch Chromium and KeePassX all the time \- they will appear in the list of commands first.
.SS Build
.sp
goboom is built using Go 1.5 vendoring and godeps.
.SS Install
.sp
goboom is available via AUR as \fIgoboom\-bin\fP\&. For binary downloads see \fI\%https://bintray.com/atriix/generic/goboom/view\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
sudo cp goboom /usr/bin
sudo cp goboom_run /usr/bin
mkdir \-p ~/.goboom
cp config.ini.default ~/.goboom/config.ini
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Set your keybinding to \fIgoboom_run\fP\&.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-gc
Run garbage collection of the DB
.TP
.B \-\-launcher
Output launcher command
.TP
.B \-\-post
Update ranking DB
.TP
.B \-\-pre
Generate dmenu in
.TP
.B \-\-stats
View DB stats
.UNINDENT
.SH MIGRATION FROM XBOOMX
.sp
goboom will look for a config file in \fI~/.goboom\fP\&.
You will need to will need to convert you old config file to ini\-format and name it \fIconfig.ini\fP, see the bundled default ini\-file for guidence.
.sp
goboom uses a csv\-file instead sqlite as datastore.
You will need to export your xboomx db as so.
At this point there is not a provided tool to do so, but you can easely export it with something like \fI\%sqlitebrowser\fP <\fBhttp://sqlitebrowser.org/\fP>\&.
.sp
The contents of your exported database should look along the lines of this:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
name,count
chroimum,13
keepassx,17
gimp,4
.ft P
.fi
.UNINDENT
.UNINDENT
.SH LICENSE
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
goboom \- a dmenu wrapper
Copyright (C) 2016 Victor Häggqvist

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
Victor Häggqvist
.SH COPYRIGHT
2016, Victor Häggqvist
.\" Generated by docutils manpage writer.
.