summaryrefslogtreecommitdiff
path: root/sys/man
diff options
context:
space:
mode:
authorcinap_lenrek <cinap_lenrek@felloff.net>2022-10-08 10:38:14 +0000
committercinap_lenrek <cinap_lenrek@felloff.net>2022-10-08 10:38:14 +0000
commit166e8b3cf8d2e087258eb47fdba7e890d6a8432a (patch)
treeda16c7d2198956abacd36cb99a6137136503a11e /sys/man
parent2a29b497f215f91d05b6718a0e852e8a9b6ce6da (diff)
parentc6ae349e9d67ef24ce429f699c5232a9acdcb1ea (diff)
merge
Diffstat (limited to 'sys/man')
-rw-r--r--sys/man/1/bar2
-rw-r--r--sys/man/1/camv51
-rw-r--r--sys/man/1/chdev12
-rw-r--r--sys/man/1/git5
-rw-r--r--sys/man/1/ktrans18
-rw-r--r--sys/man/1/reform31
-rw-r--r--sys/man/1/riow12
-rw-r--r--sys/man/2/rsa2
-rw-r--r--sys/man/4/nusb49
-rw-r--r--sys/man/6/authsrv4
-rw-r--r--sys/man/8/acmed4
-rw-r--r--sys/man/8/sol2
12 files changed, 133 insertions, 59 deletions
diff --git a/sys/man/1/bar b/sys/man/1/bar
index cc0f8f588..1a444a94b 100644
--- a/sys/man/1/bar
+++ b/sys/man/1/bar
@@ -55,7 +55,7 @@ option.
Date and time format may be set using
.I -d
option, see
-.I tmdate(2).
+.IR tmdate (2).
.SH EXAMPLES
An example of how
.I bar
diff --git a/sys/man/1/camv b/sys/man/1/camv
index 3587d712b..ec6ab4eba 100644
--- a/sys/man/1/camv
+++ b/sys/man/1/camv
@@ -1,16 +1,55 @@
.TH CAMV 1
.SH NAME
-camv, camera display
+camv \- USB camera display
.SH SYNOPSIS
-.B camv cam-device
+.B camv
+.I cam-device
.SH DESCRIPTION
.I Camv
-uses the underlying
+uses the
.I cam-device
-file system to start a graphical camera display stream.
+file tree provided by
+.IR nusb (4)
+to use and control a USB camera.
+It opens the tree's
+.I video
+file to play the video stream directly in the window.
.PP
-The file system is initialized using nusb/cam (see nusb(4)).
+The middle mouse button menu shows and allows editing the current picture settings.
+While it lists resolution, format and framerate per second,
+those must be set manually before starting
+.IR camv (1).
+One can quit the program from the right mouse button menu.
+.SH EXAMPLES
+Initialize and configure a camera before starting
+.I camv
+in its own window.
+.IP
+.EX
+% nusb/cam 5
+% window -dx 320 -dy 240 \\
+ 'label cam
+ cat <<EOF >/dev/cam5.1/ctl
+format 320x240
+fps 30
+backlight-compensation 1
+brightness 20
+contrast 95
+saturation 40
+sharpness 7
+gamma 200
+EOF
+ camv /dev/cam5.1
+\'
+.EE
.SH SOURCE
.B /sys/src/cmd/camv.c
-.SH SEE ALSO
+.SH "SEE ALSO"
.IR nusb (4)
+.SH HISTORY
+.I Camv
+first appeared in 9front (March, 2018).
+.SH BUGS
+Not all available picture settings can be set while
+.IR camv (1)
+is running, some possibly not at all.
diff --git a/sys/man/1/chdev b/sys/man/1/chdev
index a97df2c4b..cc402543d 100644
--- a/sys/man/1/chdev
+++ b/sys/man/1/chdev
@@ -81,12 +81,6 @@ then remove the ability to create more:
bind '#|' /n/pipe
chdev -r '|'
.EE
-.SH DIAGNOSTICS
-.I Chdev
-is implemented through writes to
-.BR /dev/drivers ,
-served by
-.IR cons (3).
.SH SOURCE
.B /rc/bin/chdev
.SH "SEE ALSO"
@@ -95,5 +89,11 @@ for a list of current drivers.
.PP
.IR intro (3),
.IR cons (3)
+.SH DIAGNOSTICS
+.I Chdev
+is implemented through writes to
+.BR /dev/drivers ,
+served by
+.IR cons (3).
.SH HISTORY
Chdev first appeared in 9front (May, 2022).
diff --git a/sys/man/1/git b/sys/man/1/git
index 79fd64689..32195b2b2 100644
--- a/sys/man/1/git
+++ b/sys/man/1/git
@@ -291,11 +291,6 @@ When passed the
option, the changes are pulled from
.I upstream
instead of the configured origin.
-when passed the
-.B -b
-.I branch
-option, it only pulls changes related to
-.IR branch .
.PP
.B Git/serve
diff --git a/sys/man/1/ktrans b/sys/man/1/ktrans
index 88f60471e..99b6b4039 100644
--- a/sys/man/1/ktrans
+++ b/sys/man/1/ktrans
@@ -85,15 +85,6 @@ Korean mode. Implicit layer converts latin to Korean Hangul.
.TP
.B ctrl-v
Vietnamese Telex input.
-.SH SOURCE
-.B /sys/src/cmd/ktrans
-.SH SEE ALSO
-.IR rio (4)
-.IR kbdfs (8)
-.br
-.IR /sys/src/cmd/ktrans/README.kenji
-.br
-.IR /sys/src/cmd/ktrans/READMEJ.kenji
.SH EXAMPLES
To type the following Japanese text:
@@ -112,6 +103,15 @@ nakanakatanoshiImonodesu.[\\n]
where [^\\] and [^l] indicate 'ctl-\\' and 'ctl-l',
respectively. See README.kenji for the details of this Japanese input
method.
+.SH SOURCE
+.B /sys/src/cmd/ktrans
+.SH SEE ALSO
+.IR rio (4)
+.IR kbdfs (8)
+.br
+.IR /sys/src/cmd/ktrans/README.kenji
+.br
+.IR /sys/src/cmd/ktrans/READMEJ.kenji
.SH BUGS
.PP
There is no way to generate the control characters literally.
diff --git a/sys/man/1/reform b/sys/man/1/reform
index a4e9accf7..b6afac6f0 100644
--- a/sys/man/1/reform
+++ b/sys/man/1/reform
@@ -109,9 +109,14 @@ Returns attached battery array statistics in the same manner as
.B cputemp
Exposes the current temperature reading of the CPU.
.TP
+.B kbdoled
+An image can be displayed on the keyboard OLED by writing a 126x32x1
+uncompressed Plan 9 image (with or without a header). Zero-length
+write clears the display.
+.TP
.B light
Provides a way to control the backlight of the built-in LCD by
-writing \fIlcd [-+]N\fR,
+writing \fIlcd [-+]N\fR or \fIkbd [-+]N\fR,
where
.I N
is expressed in percentage, either as an absolute value (0-100) or
@@ -145,20 +150,21 @@ to function:
reform/shortcuts </dev/kbdtap >/dev/kbdtap
.EE
.PP
-.I Super+F1/F2
+.I Hyper+F1/F2
decreases/increases LCD brightness,
-.I Super+F3/F4
-decreases/increases "master" volume,
-.I Super+Escape
-(un)mutes the audio.
-Optionally, a single step amount can be set with
+.I Hyper+F7/F8/F9
+skips to the previous track, (un)pauses or skips to the next track in
+.IR zuke (1),
+.I Hyper+F10
+(un)mutes the audio,
+.I Hyper+F11/F12
+decreases/increases "master" volume. Optionally, a single step amount
+can be set with
.I -l
for LCD light level (default is 5) and
.I -v
for volume (default is 3). Values can be negative to essentially swap
-.I F1
-with
-.IR F2 .
+the decrement and increment keys.
.SH SOURCE
.B /sys/src/cmd/reform
.SH SEE ALSO
@@ -173,8 +179,9 @@ recording is not implemented.
.B Light
was chosen as a shorter alternative to
.BR brightness .
-In the future it might support controlling keyboard and trackball
-light levels.
+.PP
+Current keyboard light level reading is only an indication, there is
+no way to get the actual value from the keyboard.
.PP
Values displayed in the
.B battery
diff --git a/sys/man/1/riow b/sys/man/1/riow
index df5ec7a1f..b49f99603 100644
--- a/sys/man/1/riow
+++ b/sys/man/1/riow
@@ -9,7 +9,7 @@ riow \- keyboard-controller for rio(1)
.SH DESCRIPTION
.I riow
provides keyboard controlling for
-.I rio(1)
+.IR rio (1)
in the manner of
.IR i3 ,
.I sway
@@ -18,13 +18,9 @@ and so on. It does so by working with
(see \fIrio\fR(4)) and
.IR /dev/wsys .
.SS Running
+Example of running
.I riow
-filters all key combinations that include
-.B Kmod4
-modifier, so it has to be placed
-.I last
-in the chain of programs using
-.IR /dev/kbdtap :
+with other programs handling input:
.EX
</dev/kbdtap ktrans | \\
reform/shortcuts | \\
@@ -56,7 +52,7 @@ option.
.TP
.B Kmod4+enter
Spawn a new
-.IR window(1) .
+.IR window (1).
.TP
.B Kmod4+h/j/k/l
Focus left/down/up/right.
diff --git a/sys/man/2/rsa b/sys/man/2/rsa
index b44f18bd6..c72105752 100644
--- a/sys/man/2/rsa
+++ b/sys/man/2/rsa
@@ -62,7 +62,7 @@ RSApub* rsaprivtopub(RSApriv*)
RSApub* X509toRSApub(uchar *cert, int ncert, char *name, int nname)
.PP
.B
-RSApub* X509reqtoRSApub(uchar *req, int nreq, char *name*, int nname)
+RSApub* X509reqtoRSApub(uchar *req, int nreq, char *name, int nname)
.PP
.B
RSApriv* asn1toRSApriv(uchar *priv, int npriv)
diff --git a/sys/man/4/nusb b/sys/man/4/nusb
index 72ba89cd3..4b69a98ff 100644
--- a/sys/man/4/nusb
+++ b/sys/man/4/nusb
@@ -145,8 +145,12 @@ to let
.IR kbdfs (8)
process them.
Mouse events are sent to
-.BR /dev/mousein
+.B /dev/mousein
in the same way.
+A file
+.BI /dev/hid N ctl
+supports setting keyboard repeat and delay setting, the unit is
+milliseconds.
.SS Joysticks
.I Joy
parses data packets from a given endpoint and prints back
@@ -271,11 +275,34 @@ compatible with
.IR audio (3).
.SS Camera devices
.I Cam
-configures and manages a USB camera device.
-It implements a file system (normally seen under
-.BR /dev ),
-compatible with
-.IR camv (1).
+configures and exposes a USB camera device's capabilities,
+implementing a file system compatible with
+.IR camv (1),
+under a directory named
+.BI cam N [. M ].
+It provides the following files:
+.BR desc ,
+showing all of the device's internal descriptors and their values;
+.BR format ,
+listing admissible image resolutions and framerates;
+.BR ctl ,
+the picture settings control file;
+.BR frame ,
+which captures and outputs a single video frame as an
+.IR image (6)
+file;
+and
+.IR video ,
+streaming video in a preset format, resolution and framerate.
+In particular, reading from the
+.B ctl
+file yields a space-separated list of parameter settings,
+where the second and third columns correspond to key-value pairs,
+and an optional fourth column corresponds to the range of possible numerical values
+(formatted as
+.IR minimum / increment / maximum ).
+The same pairs can be written to the file to configure the camera.
+Currently, only the YUY2 video format is supported.
.SH SOURCE
.B /sys/src/cmd/nusb
.SH "SEE ALSO"
@@ -288,11 +315,15 @@ compatible with
.IR uart (3),
.IR usb (3),
.IR shr (3),
+.IR image (6),
.IR nusbrc (8),
.IR kbdfs (8)
.SH HISTORY
.I Joy
first appeared in 9front (March, 2014).
+.br
+.I Cam
+first appeared in 9front (March, 2018).
.SH BUGS
The various device drivers are generic USB drivers and
may work only for certain devices of each class.
@@ -307,3 +338,9 @@ and
signals and some of the extra features are not implemented.
For Ftdi, only the Sheevaplug and Guruplug have been tried.
There is support for the EHCI debug port, but it loses bytes.
+.PP
+USB video format settings cannot be changed while
+.IR camv (1)
+is running, and must be set manually by writing them to
+.IR cam (4)'s ctl
+file before starting the viewer.
diff --git a/sys/man/6/authsrv b/sys/man/6/authsrv
index 08342885a..1e835934a 100644
--- a/sys/man/6/authsrv
+++ b/sys/man/6/authsrv
@@ -593,8 +593,8 @@ and
.IR attach (5)).
Other services, such as
.IR rcpu (1),
-.IR rexport(1),
-.IR rimport(1)
+.IR rexport (1),
+.IR rimport (1)
and
.IR tlssrv (8)
run
diff --git a/sys/man/8/acmed b/sys/man/8/acmed
index 7eb924316..ec094bd17 100644
--- a/sys/man/8/acmed
+++ b/sys/man/8/acmed
@@ -144,7 +144,7 @@ auth/rsa2jwk acct.key > /sys/lib/tls/acmed/me@example.com.pub
Then the
.B acct.key
must be loaded into
-.IR factotum(4).
+.IR factotum (4).
It is recommended to put
.B acct.key
into
@@ -173,7 +173,7 @@ for more examples on how to use RSA keys.
.PP
The certificate for the domain can now be fetched.
This requires
-.IR webfs(4)
+.IR webfs (4)
to be mounted as the ACME protocol uses HTTP
to talk to the provider.
.IP
diff --git a/sys/man/8/sol b/sys/man/8/sol
index 58ecf057f..64ffd8fda 100644
--- a/sys/man/8/sol
+++ b/sys/man/8/sol
@@ -47,7 +47,7 @@ The
flag connects to the VNC port instead.
.SH EXAMPLE
Connect to the KVM port with
-.IR vnc(1):
+.IR vnc (1):
.IP
.EX
execnet && vncv 'exec!ip/sol -k host'