gamemode/data/gamemodelist.1.in
Sam Gleske c96f7379b4
New utility: gamemodelist (#346)
* New utility: gamemodelist

While trying out gamemode on Ubuntu 18.04 I had trouble figuring out
whether or not my games were running with gamemode enabled.  I wrote this
utility which prints all processes loaded with the gamemode shared
library.

- [x] Added utility to `data/` folder.
- [x] Update meson installer.
- [x] Included section 1 manual.
- [x] Updated README for Ubuntu 18.04 build instructions.  Steam supports
  Ubuntu 18.04.

I'm open to feedback and generally this should work for any distrobution
since it makes use of the Linux `/proc` filesystem.  [Learn more about
`/proc`][1].

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/tree/Documentation/filesystems/proc.rst?h=v5.15.12
2022-02-21 09:50:57 +00:00

69 lines
1.9 KiB
Groff

.\" Manpage for gamemoderun.
.\" Contact linux-contact@feralinteractive.com to correct errors or typos.
.TH gamemodelist 1 "4 May 2020" "@GAMEMODE_VERSION@" "gamemodelist man page"
.SH NAME
gamemodelist \- search for processes running with gamemode
.SH SYNOPSIS
\fBgamemodelist\fR
.SH DESCRIPTION
\fBgamemodelist\fR will search the runtime of all processes running which started \fBGameMode\fR via \fBlibgamemodeauto.so\fR and print them with
.BR ps (1)
command output. This helper script makes it easy to find which processes are utilizing \fBGameMode\fR via \fBlibgamemodeauto.so\fR when troubleshooting potential game issues.
.SH USAGE
\fBlibgamemodeauto.so.0\fR will be found in the shared object maps of running processes utilizing \fBGameMode\fR. Run the following command to print processes loaded with \fBlibgamemodeauto.so.0\fR. \fBGameMode\fR can be started other ways but this script will only detect processes utilizing \fBGameMode\fR via \fBlibgamemodeauto.so\fR.
.RS 4
gamemodelist
.RE
.SH OUTPUT
The output is a process table from
.BR ps (1)
command.
.RS 4
PID PPID USER NI PSR COMMAND
.RE
Where each of these fields are defined in
.BR ps (1)
manual. For your convenience here's a definition for each field.
.RS 4
.TS
l lw(3i).
\fBCOLUMN DESCRIPTION\fR
PID Process ID
PPID Parent process ID
USER User name owning the process.
NI T{
Nice value. This ranges from 19 (nicest) to \-20 (not nice to others),
See
.IR nice (1).
T}
PSR T{
Processor that process is currently assigned to. Useful when setting process affinity using
.IR taskset (1)
utility.
T}
COMMAND Command name (only the executable name).
.TE
.RE
.SH SEE ALSO
.BR gamemodrun (1),
.BR nice (1),
.BR ps (1),
.BR taskset (1).
.SH ABOUT
GameMode source can be found at \fIhttps://github.com/FeralInteractive/gamemode.git\fR
.SH AUTHOR
.BR gamemodelist
was authored by Sam Gleske (https://github.com/samrocketman/)
.BR GameMode
was authored by Feral Interactive (linux-contact@feralinteractive.com)