From 6d4eece8f967a22a62501963acb96f6740c3a8fb Mon Sep 17 00:00:00 2001 From: Mykyta Holubakha Date: Wed, 24 Jan 2018 22:35:21 +0200 Subject: Improved manpage thanks @SirCmpwn --- Makefile | 3 -- brightnessctl.1 | 141 +++++++++++++++++++++++++++++++++++++++++++++++++++++ brightnessctl.1.in | 135 -------------------------------------------------- 3 files changed, 141 insertions(+), 138 deletions(-) create mode 100644 brightnessctl.1 delete mode 100644 brightnessctl.1.in diff --git a/Makefile b/Makefile index 01efcb8..cc9e53c 100644 --- a/Makefile +++ b/Makefile @@ -17,9 +17,6 @@ MODE = ${MODE_${INSTALL_UDEV_RULES}} all: brightnessctl brightnessctl.1 -brightnessctl.1: brightnessctl.1.in - sed 's/VERSION/$(VERSION)/g' $< > $@ - install: all ${INSTALL_UDEV_${INSTALL_UDEV_RULES}} install -d ${BINDIR} ${MANDIR}/man1 install -m ${MODE} brightnessctl ${BINDIR}/ diff --git a/brightnessctl.1 b/brightnessctl.1 new file mode 100644 index 0000000..46f59db --- /dev/null +++ b/brightnessctl.1 @@ -0,0 +1,141 @@ +.TH "BRIGHTNESSCTL" "1" "24th Jan 2018" "brightnessctl" "brightnessctl" + +.SH "NAME" +brightnessctl \- read and control device brightness + + +.SH "SYNOPSIS" + +.sp +\fIbrightnessctl\fR [options] \fI[operation]\fR [value...] + + +.SH "OPTIONS" + +.sp +\fB\-h, \-\-help\fP +.RS 4 +Print this help. +.RE + +.sp +\fB\-l, \-\-list\fP +.RS 4 +List devices with available brightness controls. +.RE + +.sp +\fB\-q, \-\-quiet\fP +.RS 4 +Suppress output. +.RE + +.sp +\fB\-p, \-\-pretend\fP +.RS 4 +Do not perform write operations. +.RE + +.sp +\fB\-m, \-\-machine\-readable\fP +.RS 4 +Produce machine\-readable output. +.RE + +.sp +\fB\-s, \-\-save\fP +.RS 4 +Save state in a temporary file. +.RE + +.sp +\fB\-r, \-\-restore\fP +.RS 4 +Restore previously\-saved state. +.RE + +.sp +\fB\-d, \-\-device\fP=\fIDEVICE\fP +.RS 4 +Specify device name (can be a wildcard). +.RE + +.sp +\fB\-c, \-\-class\fP=\fICLASS\fP +.RS 4 +Specify device class. +.RE + +.sp +\fB\-v, \-\-version\fP +.RS 4 +Print version and exit. +.RE + + +.SH "OPERATIONS" + +.sp +\fBi, info\fP +.RS 4 +Get device info. +.RE + +.sp +\fBg, get\fP +.RS 4 +Get the current brightness of the device. +.RE + +.sp +\fBm, max\fP +.RS 4 +Get the maximum brightness of the device. +.RE + +.sp +\fBs, set\fP \fIVALUE\fP +.RS 4 +Set the brightness of the device. + +.SS VALUES +.P +You may specify \fIVALUE\fR for the \fBset\fR command in absolute or relative form, and +as a value or a delta from the current value. For example: +.P +\fBbrightnessctl set 500\fR +.RS "4" +Sets brightness to 500. +.P +.RE +\fBbrightnessctl set 50%\fR +.RS "4" +Sets brightness to 50% of the maximum. +.P +.RE +\fBbrightnessctl set 50-\fR +.RS "4" +Subtracts 50 from the current brightness. +.P +.RE +\fBbrightnessctl set +10\fR +.RS "4" +Adds 10 to the current brightness. +.P +.RE +\fBbrightnessctl set 50%-\fR +.RS "4" +Subtracts 50% of the maximum from the current brightness. +.P +.RE +\fBbrightnessctl set +10%\fR +.RS "4" +Adds 10% of the maximum to the current brightness. +.P +.RE +.SH AUTHORS +.P +Maintained by Mykyta Holubakha, who is assisted by other open source +contributors. For more information about brightnessctl development, visit: +.P +https://github.com/Hummer12007/brightnessctl diff --git a/brightnessctl.1.in b/brightnessctl.1.in deleted file mode 100644 index febe458..0000000 --- a/brightnessctl.1.in +++ /dev/null @@ -1,135 +0,0 @@ -'\" t -.\" Title: brightnessctl -.\" Author: Mykyta Holubakha -.\" Language: English -.\" -.TH "BRIGHTNESSCTL" "1" "VERSION" "brightnessctl" "brightnessctl" - -.SH "NAME" -brightnessctl \- read and control device brightness - - -.SH "SYNOPSIS" - -.sp -\fBbrightnessctl\fP [\(aqOPTION\(aq]... [\(aqOPERATION\(aq]... [\(aqVALUE\(aq]... - - -.SH "OPTIONS" - -.sp -\fB\-h, \-\-help\fP -.RS 4 -Print this help. -.RE - -.sp -\fB\-l, \-\-list\fP -.RS 4 -List devices with available brightness controls. -.RE - -.sp -\fB\-q, \-\-quiet\fP -.RS 4 -Suppress output. -.RE - -.sp -\fB\-p, \-\-pretend\fP -.RS 4 -Do not perform write operations. -.RE - -.sp -\fB\-m, \-\-machine\-readable\fP -.RS 4 -Produce machine\-readable output. -.RE - -.sp -\fB\-s, \-\-save\fP -.RS 4 -Save state in a temporary file. -.RE - -.sp -\fB\-r, \-\-restore\fP -.RS 4 -Restore previously\-saved state. -.RE - -.sp -\fB\-d, \-\-device\fP=\fIDEVICE\fP -.RS 4 -Specify device name (can be a wildcard). -.RE - -.sp -\fB\-c, \-\-class\fP=\fICLASS\fP -.RS 4 -Specify device class. -.RE - -.sp -\fB\-v, \-\-version\fP -.RS 4 -Print version and exit. -.RE - - -.SH "OPERATIONS" - -.sp -\fBi, info\fP -.RS 4 -Get device info. -.RE - -.sp -\fBg, get\fP -.RS 4 -Get the current brightness of the device. -.RE - -.sp -\fBm, max\fP -.RS 4 -Get the maximum brightness of the device. -.RE - -.sp -\fBs, set\fP \fIVALUE\fP -.RS 4 -Set the brightness of the device. - -Valid values: -.IP \[bu] 2 -absolute value: 500 -.IP \[bu] -relative value: 50% -.IP \[bu] -absolute delta: 50- or +10 -.IP \[bu] -relative delta: 50%- or +10% -.RE - - -.SH "RESOURCES" -.sp -\fBProject development repository:\fP \c -https://github.com/Hummer12007/brightnessctl - - -.SH "COPYING" -.sp -Copyright \(co 2016\-2018 Mykyta Holubakha. - -Free use of this software is granted under the terms of the MIT/Expat License. - - -.SH "AUTHOR(S)" -.sp -\fBMykyta Holubakha\fP - -\fBNicolas Braud-Santoni\fP (manpage) -- cgit v1.2.3