Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add stub manpage for irqbalance-ui #111

Merged
merged 3 commits into from
Jul 23, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ irqbalance_ui_LDADD = $(GLIB2_LIBS) $(CURSES_LIBS)
endif

dist_man_MANS = irqbalance.1
if IRQBALANCEUI
dist_man_MANS += irqbalance-ui.1
endif

CONFIG_CLEAN_FILES = debug*.list config/*
clean-generic:
Expand Down
40 changes: 40 additions & 0 deletions irqbalance-ui.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "IRQBALANCE-UI" 1 "Jul 2019" "Linux" "irqbalance-ui"
.SH NAME
irqbalance-ui \- user interface for irqbalance
.SH "SYNOPSIS"

.nf
\fBirqbalance-ui\fR
.fi

.SH "DESCRIPTION"

.PP
\fBirqbalance-ui\fR provides an ncurses-based textual user interface to
\fBirqbalance\fR, a daemon responsible for IRQ distribution on Linux systems.
It shows how IRQs are distributed over CPUs at given moment, and allows one to
setup of the sleep interval and the IRQ and CPU banning at runtime.

.SH "HOMEPAGE"
https://github.com/Irqbalance/irqbalance

.SH "SEE ALSO"
irqbalance(1)
2 changes: 1 addition & 1 deletion irqbalance.1
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,6 @@ Ban listed IRQs from being balanced, all old values of banned IRQs are forgotten
irqbalance checks SCM_CREDENTIALS of sender (only root user is allowed to interact).
Based on chosen tools, ancillary message with credentials needs to be sent with request.

.SH "Homepage"
.SH "HOMEPAGE"
https://github.com/Irqbalance/irqbalance