diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/luxget.3 | 8 | ||||
| -rw-r--r-- | man/luxinit.3 | 14 |
2 files changed, 11 insertions, 11 deletions
diff --git a/man/luxget.3 b/man/luxget.3 index 5ada1a9..1216a21 100644 --- a/man/luxget.3 +++ b/man/luxget.3 @@ -15,7 +15,7 @@ .\" OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: September 8 2022 $ +.Dd $Mdocdate: September 9 2022 $ .Dt LUXGET 3 .Os .Sh NAME @@ -37,7 +37,7 @@ The function takes a pointer to a .Vt "struct luxdisp" structure and returns the raw brightness value of the associated display. -If the function returns \-1 it means that an error has occured, however this is +If the function returns \-1 it means that an error has occurred, however this is only possible if .Va disp has not yet been passed to any other library function that interacts with the @@ -49,7 +49,7 @@ The function behaves identically to the .Fn luxget function except it returns the maximum supported brightness of the display -refered to by +referred to by .Va disp . Additionally, this function can only error if .Va disp @@ -65,7 +65,7 @@ function takes a pointer to a .Vt "struct luxdisp" structure and returns the brightness of the associated display as a percentage. A return value of 100.0 means the display is at 100% brightness. -If the function returns \-1 it means that an error has occured. +If the function returns \-1 it means that an error has occurred. Internally this function calls both .Fn luxget and diff --git a/man/luxinit.3 b/man/luxinit.3 index a16ecd1..62be99f 100644 --- a/man/luxinit.3 +++ b/man/luxinit.3 @@ -15,13 +15,13 @@ .\" OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: September 8 2022 $ +.Dd $Mdocdate: September 9 2022 $ .Dt LUXINIT 3 .Os .Sh NAME .Nm luxinit , .Nm luxfree -.Nd initialize and destroy a luxdisp struct +.Nd initialise and destroy a luxdisp struct .Sh SYNOPSIS .In lux.h .Ft int @@ -31,7 +31,7 @@ .Sh DESCRIPTION The .Fn luxinit -function initializes the values of the +function initialises the values of the .Vt "struct luxdisp" structure pointed to by .Va disp . @@ -40,7 +40,7 @@ Allocation of is left up to the user. All .Vt "struct luxdisp" -structures should be initialized with the +structures should be initialised with the .Fn luxinit function before being used with any other library functions. .Pp @@ -54,13 +54,13 @@ structure pointed to by .Va disp . This function should be called for all .Vt "struct luxdisp" -structures that have been initialized by +structures that have been initialised by .Fn luxinit after they are no longer required. .Sh RETURN VALUES The .Fn luxinit -function returns the file descriptior of the directory containing the backlight +function returns the file descriptor of the directory containing the backlight files located in .Pa /sys/class/backlight on success. @@ -72,7 +72,7 @@ The .Fn luxfree function returns no value. .Sh EXAMPLES -The following program initializes a new +The following program initialises a new .Vt "struct luxdisp" structure, uses it to set the display brightness to 100%, and then frees the resources used by the structure. |