summaryrefslogtreecommitdiff
path: root/doc/dwbem.1.txt
blob: d7df0c7b766cb30fcc5f14782c13c575a4feef86 (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
// See COPYING for copyright and license details

// vim: set ft=asciidoc:
DWBEM(1)
========
:doctype: manpage


NAME
----
dwbem - dwb extension manager

SYNOPSIS
--------
*dwbem* ['OPTIONS'] 

DESCRIPTION
-----------
*dwbem* is a command line tool that handles extensions for dwb.

OPTIONS
-------
*-a*::
*--list-all*:: 
  List all available extensions that can be handled by dwbem, if an extension is
  installed it will be indicated with an 'i', if it is disabled it will be
  indicated with a 'd'.
 
*-b*::
*--bind*::
  When used together with *-i* the extension will be loaded with 'extensions.bind'
  instead of extensions.load, i.e. it is possible to bind a shortcut for
  enabling/disabling the extension on the fly.

*-B* 'extension':: 
*--setbind* 'extension'::
  Edit configuration of 'extension', the extension will be loaded with 'extensions.bind', 
  i.e. it is possible to bind a shortcut for enabling/disabling
  the extension on the fly, see also -L.

*-c* 'extension'::
*--config* 'extension':: 
  Show configuration for extension 'extension'.

*-d* 'extension'::
*--disable* 'extension'::
  Disable 'extension', the extension will still be installed and the
  configuration will be kept.

*-e* 'extension'::
*--enable* 'extension'::
  Enable an extension that was previously disabled with *-d*.

*-E* 'extension'::
*--edit* 'extension'::
  Edit configuration of 'extension' with an editor, the 'EDITOR' environment
  variable needs to be set for this option. 

*-i* 'extension'::
*--install* 'extension'::
  Install 'extension'. If it is a local extension that was installed together
  with dwb the extension will not be downloaded, only the default configuration
  will  be set. Note that reinstalling an already installed extension will
  overwrite the configuration with the default configuration.

*-I* 'extension':: 
*--info* 'extension'::
  Show information about 'extension'.

*-l*:: 
*--list*::
  List installed extensions handled by dwbem, if an extension is disabled it
  will indicated with a 'd'.

*-L* 'extension':: 
*--setload* 'extension'::
  Edit configuration for 'extension'. The extension will be loaded with
  'extensions.load', see also *-B*.

*-n*::
*--no-config*:: 
  Don't use a configuration in the loader script, use
  '$XDG_CONFIG_HOME/dwb/extensionrc' instead. The extension will simply be
  loaded with 'extensions.load("extension");'. This option can be combined with *-i*,
  *-B* or *-L*. If combined with *-i* it will be applied to all installed
  extensions.

*-N*::
*--no-confirm*:: 
  Can be combined with *-i*, *-u*, *-U*, *-L* or *-B*. When set most questions are skipped. When
  combined with *-i* an existing configuration will be overwritten with the
  default configuration. When combined  with *-u* or *-U* the check for changed
  configurations is skipped, when combined with *-L* or *-B* editing
  configuration is skipped. 

*-r* 'extension':: 
*--remove* 'extension'::
  Remove an extension. If it is a remote extension the extension will be
  deleted. This option also discards the configuration. 

*-p* 'extension':: 
*--proxy* 'extension'::
  HTTP-proxy to use, also overrides the environment variables *https_proxy* and *http_proxy*.

*-u*::
*--upgrade*::
  Update installed extensions. 

*-U* 'extension'::
*--update* 'extension'::
  Update 'extension', the update will be forced. It is also useful to check if
  the configuration has been changed after using *--upgrade* in combination
  with *--no-confirm*.


ENVIRONMENT VARIABLES
---------------------
*dwbem* expects the environment variables 'EDITOR' and 'DIFF_VIEWER' to be set,
if they are unset 'vim' and 'vimdiff' are used respectively. 'EDITOR' needs to
be set if the configuration is edited or a new extension is installed,
'DIFF_VIEWER' needs to be set if extensions are updated. 


SEE ALSO
--------
*dwb*(1) *dwb-js*(7)