diff options
Diffstat (limited to 'share/man/man1/nerve.1')
-rw-r--r-- | share/man/man1/nerve.1 | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/share/man/man1/nerve.1 b/share/man/man1/nerve.1 new file mode 100644 index 0000000..8f2d19e --- /dev/null +++ b/share/man/man1/nerve.1 @@ -0,0 +1,73 @@ +.\" Copyright (c) 2025 Ian Marco Moffett and the Osmora Team. +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions are met: +.\" +.\" 1. Redistributions of source code must retain the above copyright notice, +.\" this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. Neither the name of Hyra nor the names of its +.\" contributors may be used to endorse or promote products derived from +.\" this software without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.Dd Jul 18 2025 +.Dt NERVE 1 +.Os HYRA +.Sh NAME +.Nm nerve - interact with control files +.Sh SYNOPSIS +nerve <verb> [ .. payload for pokes ..] + +verb 'poke': Poke a nerve + +verb 'peek': Peek at a nerve + +nerve ending 'consattr': Console attributes + +nerve ending 'consfeat': Console features + +.Sh DESCRIPTION + +The +.Nm +command can be used to modify system attributes and behaviour through various +nerve endings (e.g., control files, et cetera). To drive a nerve, one must provide +a verb (describing an operation) as well as a payload. An example of this command +is moving the cursor position to the HOME (0, 0) position: + +.Bd -literal +nerve poke consattr 0 0 + / / / / + verb nerve [x] [y] +.Ed + +A nerve may also be peeked at by using the 'peek' verb. Here is an example of the usage +of this verb: + +.Bd -literal +nerve peek consfeat + / / + verb nerve + +output: + ansi_esc=1 + show_curs=0 + ... +.Ed + +.Sh AUTHORS +.An Ian Moffett Aq Mt ian@osmora.org |