Manpage for uivibrate, a tool included in uikittools-ng

uivibrate.1

.\"
.\" uivibrate.1
.\" Copyright (c) 2022-present TheRealKeto
.\"
.\" SPDX-License-Identifier: BSD-4-Clause
.\" Created by TheRealKeto on 7/24/2022
.\"
.Dd July 24, 2022
.Dt UIVIBRATE 1
.Os
.Sh NAME
.Nm uivibrate
.\" Change this later. ps: fuck you
.Nd makes your phone go brrrrr
.Sh SYNOPSIS
.Nm
.Op Fl t Ar type
.Op Fl d Ar duration
.Op Fl i Ar intensity
.Sh OPTIONS
.Bl -tag -width -indent
.It Fl t , -type
Use a different vibration type.
.It Fl d , -duration
Set the duration of the vibration.
The duration of the vibration can be from seconds ('s', used
by default), minutes ("m"), hours ("h"), or days ("d").
.It Fl i , -intensity
Set the intensity of the vibration.
.El
.Sh VIBRATIONS
.Nm
can preform various types of vibrations.
By default,
.Nm
will perform a medium vibration for 1 second if no other
arguements are passed.
Users can choose from various vibration types, some which are
used to specify a state of the vibration, which include
.Pp
.Dl light
.Dl medium
.Dl soft
.Dl sucess
.Dl rigid
.Dl warning
.Dl heavy
.Dl error
.Dl selection-change
.Sh EXAMPLES
To simulate a rigid vibration for 20 seconds
.Dl uivibrate -t rigid -d 20
To simulate a vibration used when a new option has been changed
.Dl uivibrate -t selection-change
.\" TODO: Add example for setting intensity
.Sh HISTORY
.Nm
.\" TODO: Add the actual date when it actually gets merged
.\" TODO: Maybe look into the history behind this, if any
was added by Serena, at some point in time.
This very own manpage was written by
.An Keto (TheRealKeto)
on July 24, 2022.