summaryrefslogtreecommitdiffstats
path: root/man8/systeroid-tui.8
blob: c6617d20a6ccd4d241d37cf527d0a0f13cb343a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
.\" Manpage for systeroid-tui

.TH SYSTEROID-TUI "8" "2022-09-06" "systeroid-tui" "System Administration"
.SH NAME
systeroid-tui \- manage kernel parameters with a terminal user interface

.SH SYNOPSIS
.B systeroid-tui
[options]

.SH DESCRIPTION
.B systeroid-tui
is used to configure and view kernel parameters with a terminal user interface.

.SH PARAMETERS
.TP
\fB\-t\fR, \fB\-\-tick\-rate\fR <ms>
Use this option to set the tick rate of the terminal. [default: 250]
.TP
\fB\-D\fR, \fB\-\-docs\fR <path>
Use this option to set a custom path for the kernel documentation.
.TP
\fB\-s\fR, \fB\-\-section\fR <section>
Use this option to set the section to filter.
.HP
\fB\-q\fR, \fB\-\-query\fR <query> set the query to search.
.TP
\fB\-\-bg\-color\fR <color>
Use this option to set the background color. [default: black]
.TP
\fB\-\-fg\-color\fR <color>
Use this option to set the foreground color. [default: white]
.TP
\fB\-n\fR, \fB\-\-no\-docs\fR
Do not show the kernel documentation.
.TP
\fB\-\-deprecated\fR
Include deprecated variables while listing.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display help text and exit.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version information and exit.

.SH EXAMPLES
systeroid-tui \-t 500
.br
systeroid-tui \-s kernel
.br
systeroid-tui \-q "fs.quota"
.br
systeroid-tui \-\-fg-color blue
.br
systeroid-tui \-\-bg-color ffff99 \-\-fg-color 003366
.br
systeroid-tui \-D /usr/share/doc/linux
.br
systeroid-tui -n

.SH KEY BINDINGS
.TS
tab(@);
l l.
T{
Key
T}@T{
Action
T}
_
T{
?, f1
T}@T{
show help
T}
T{
up/down, k/j, pgup/pgdown
T}@T{
scroll list
T}
T{
t/b
T}@T{
scroll to top/bottom
T}
T{
left/right, h/l
T}@T{
scroll documentation
T}
T{
tab, \[ga]
T}@T{
next/previous section
T}
T{
:
T}@T{
command
T}
T{
/, s
T}@T{
search
T}
T{
enter
T}@T{
select / set parameter value
T}
T{
c
T}@T{
copy to clipboard
T}
T{
r, f5
T}@T{
refresh
T}
T{
esc
T}@T{
cancel / exit
T}
T{
q, ctrl-c/ctrl-d
T}@T{
exit
T}
.TE

.SH SEE ALSO
.BR systeroid (8)

.SH AUTHOR
.UR orhunparmaksiz@gmail.com
Orhun Parmaksız
.UE

.SH COPYRIGHT
Copyright © 2022 Orhun Parmaksız
.RS 0
Licensed under either of Apache License Version 2.0 or The MIT License at your option.

.SH REPORTING BUGS
Report bugs at <https://github.com/orhun/systeroid/issues> or contact the author via email.
.RS 0
See the project homepage at <https://github.com/orhun/systeroid> for full documentation.