-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
33a246e
commit e492c74
Showing
3 changed files
with
53 additions
and
198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,341 +1,187 @@ | ||
.\" Generated by scdoc 1.11.2 | ||
.\" Generated by scdoc 1.11.3 | ||
.\" Complete documentation for this program is not available as a GNU info page | ||
.ie \n(.g .ds Aq \(aq | ||
.el .ds Aq ' | ||
.nh | ||
.ad l | ||
.\" Begin generated content: | ||
.TH "MACCHINA" "1" "2024-02-03" | ||
.P | ||
.TH "MACCHINA" "1" "2024-09-29" | ||
.PP | ||
.SH NAME | ||
.P | ||
.PP | ||
macchina - A system information frontend, with an (unhealthy) emphasis | ||
on performance.\& | ||
.P | ||
.PP | ||
.SH SYNOPSIS | ||
.P | ||
.PP | ||
\fBmacchina\fR [FLAGS] | ||
.P | ||
.PP | ||
.SH FLAGS | ||
.P | ||
.PP | ||
\fB-d, --doctor\fR | ||
.RS 4 | ||
Checks the system for failures.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-e, --export-config\fR | ||
.RS 4 | ||
Prints a template configuration file to stdout.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-c, --config\fR=\fIFILE\fR | ||
.RS 4 | ||
Specify a custom path to a configuration file.\& | ||
.P | ||
.PP | ||
This is helpful in cases where macchina fails to parse the configuration | ||
file from the default path, i.\&e.\& \fB$XDG_CONFIG_HOME/macchina/macchina.\&toml\fR.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-l, --list-themes\fR | ||
.RS 4 | ||
Lists all available themes.\& | ||
.P | ||
.PP | ||
Themes are \fBTOML\fR files which must be placed in | ||
\fB$XDG_CONFIG_HOME/macchina/themes\fR.\& Whatever this flag | ||
returns to the console can be used with the \fB--theme\fR flag.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-t, --theme\fR=\fITHEME\fR | ||
.RS 4 | ||
Specify the name of the theme to use, i.\&e.\& its basename and | ||
without the ".\&toml" extension.\& | ||
.P | ||
.PP | ||
You should verify whether macchina was able to find your theme | ||
with \fB--list-themes\fR.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-i, --interface\fR=\fIIF_NAME\fR | ||
.RS 4 | ||
Specify the network interface for the LocalIP readout, e.\&g.\& "wlan0", "eth0".\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-s, --current-shell\fR | ||
.RS 4 | ||
Toggles between the current shell, i.\&e.\& the parent of the terminal emulator, or the default one.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-C, --logical-cores\fR | ||
.RS 4 | ||
Toggles between logical and physical cores for the Processor readout.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-K, --long-kernel\fR | ||
.RS 4 | ||
Lengthens kernel output.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-S, --long-shell\fR | ||
.RS 4 | ||
Lengthens shell output.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-U, --long-uptime\fR | ||
.RS 4 | ||
Lengthens uptime output.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-m, --memory-percentage\fR | ||
.RS 4 | ||
Show memory usage in percentage | ||
.P | ||
.PP | ||
.RE | ||
\fB-D, --disks\fR | ||
.RS 4 | ||
Specify the disks for which the usage percentage will be shown | ||
.PP | ||
.RE | ||
\fB-p, --disk-space-percentage\fR | ||
.RS 4 | ||
Show disk space usage in percentage | ||
.P | ||
.PP | ||
.RE | ||
\fB-h, --help\fR | ||
.RS 4 | ||
Prints help information.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-v, --version\fR | ||
.RS 4 | ||
Prints version information.\& | ||
.P | ||
.PP | ||
.RE | ||
\fB-o, --show\fR | ||
.RS 4 | ||
Display only the specified readouts.\& | ||
.P | ||
.PP | ||
Please note that the order these are listed in will be the order that they are | ||
displayed in.\& | ||
.P | ||
.PP | ||
Possible values are (case-sensitive): | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.PD 0 | ||
.IP \(bu 4 | ||
.\} | ||
Host | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Machine | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Kernel | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Distribution | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
OperatingSystem | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
DesktopEnvironment | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
WindowManager | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Packages | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Shell | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Terminal | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
LocalIP | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Backlight | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Resolution | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Uptime | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Processor | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
ProcessorLoad | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Memory | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Battery | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
GPU | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
DiskSpace | ||
|
||
.RE | ||
.P | ||
.PD | ||
.PP | ||
.RE | ||
\fB--ascii-artists\fR | ||
.RS 4 | ||
Lists the original artists of the ASCII art used by macchina.\& | ||
.P | ||
.PP | ||
.RE | ||
.SH SEE ALSO | ||
.P | ||
.PP | ||
macchina(7) | ||
.P | ||
.PP | ||
.SH AUTHORS | ||
.P | ||
.PP | ||
Written and maintained by the Macchina-CLI team: | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.PD 0 | ||
.IP \(bu 4 | ||
.\} | ||
Taha Aziz Ben Ali <ba.\&tahaaziz@gmail.\&com> | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Uttarayan Mondal <email@uttarayan.\&me> | ||
.RE | ||
.RS 4 | ||
.ie n \{\ | ||
\h'-04'\(bu\h'+03'\c | ||
.\} | ||
.el \{\ | ||
.IP \(bu 4 | ||
.\} | ||
Marvin Haschker <marvin@haschker.\&me> | ||
|
||
.RE | ||
.P | ||
.PD | ||
.PP | ||
.SH RESOURCES | ||
.P | ||
.PP | ||
This project is hosted at \fBhttps://github.\&com/Macchina-CLI/macchina\fR.\& |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.