README.md
1
2# ABOUT
3
4**dsbbatmon**
5is a Qt battery monitor for FreeBSD. It displays the battery's current status,
6capacity, and remaining time when you move the mouse cursor over its tray icon.
7**dsbbatmon**
8can automatically shut down or suspend your system if the battery's
9capacity falls short of a certain percental value.
10
11# INSTALLATION
12
13## Dependencies
14
15**dsbbatmon**
16depends on devel/qt5-buildtools, devel/qt5-core, devel/qt5-linguisttools,
17devel/qt5-qmake, x11-toolkits/qt5-gui, and x11-toolkits/qt5-widgets
18
19## Building and installation
20
21 # git clone https://github.com/mrclksr/DSBBatmon.git
22 # git clone https://github.com/mrclksr/dsbcfg.git
23
24 # cd DSBBatmon && qmake && make
25 # make install
26
27# SETUP
28
29## Permissions
30
31In order to be able to execute
32*shutdown*
33as regular user, you can either use
34sudo(8) (see below), or you can add your username to the
35*operator*
36group:
37
38 # pw groupmod operator -m yourusername
39
40If you want to be able to suspend your system as
41regular user who is member of the wheel group, you can use
42sudo(8).
43Add
44
45 %wheel ALL=(ALL) NOPASSWD: /usr/sbin/acpiconf *
46
47to
48*/usr/local/etc/sudoers*.
49
50**Note**:
51On FreeBSD >= 12, members of the
52*operator*
53group are allowed to suspend the system via
54acpiconf(8).
55Using
56sudo(8)
57is not necessary.
58
59
readme.mdoc
1.Dd $Mdocdate$
2.Dt DSBBatmon 1
3.Os
4.Sh ABOUT
5.Nm dsbbatmon
6is a Qt battery monitor for FreeBSD. It displays the battery's current status,
7capacity, and remaining time when you move the mouse cursor over its tray icon.
8.Nm
9can automatically shut down or suspend your system if the battery's
10capacity falls short of a certain percental value.
11.Sh INSTALLATION
12.Ss Dependencies
13.Nm
14depends on devel/qt5-buildtools, devel/qt5-core, devel/qt5-linguisttools,
15devel/qt5-qmake, x11-toolkits/qt5-gui, and x11-toolkits/qt5-widgets
16.Ss Building and installation
17.Bd -literal
18# git clone https://github.com/mrclksr/DSBBatmon.git
19# git clone https://github.com/mrclksr/dsbcfg.git
20
21# cd DSBBatmon && qmake && make
22# make install
23.Ed
24.Sh SETUP
25.Ss Permissions
26In order to be able to execute
27.Em shutdown
28as regular user, you can either use
29.Xr sudo 8 (see below), or you can add your username to the
30.Em operator
31group:
32.Bd -literal -offset indent
33# pw groupmod operator -m yourusername
34.Ed
35
36If you want to be able to suspend your system as
37regular user who is member of the wheel group, you can use
38.Xr sudo 8 .
39Add
40.Bd -literal -offset indent
41%wheel ALL=(ALL) NOPASSWD: /usr/sbin/acpiconf *
42.Ed
43
44to
45.Em /usr/local/etc/sudoers .
46.Pp
47.Sy Note :
48On FreeBSD >= 12, members of the
49.Em operator
50group are allowed to suspend the system via
51.Xr acpiconf 8 .
52Using
53.Xr sudo 8
54is not necessary.
55