Stable version 0.7 heavily tested in many different CPUs

This commit is contained in:
Dr-Noob
2020-09-01 20:44:48 +02:00
parent 877833db0a
commit 500ccfa871
3 changed files with 64 additions and 48 deletions

View File

@@ -1,10 +1,10 @@
.TH man 8 "12 Jul 2020" "0.6" "cpufetch man page"
.TH man 8 "1 Sep 2020" "0.7" "cpufetch man page"
.SH NAME
cpufetch \- Prints a fancy summary of the CPU with some advanced information
.SH SYNOPSIS
cpufetch [--version] [--help] [--levels] [--style fancy|retro|legacy] [--color 'R,G,B:R,G,B:R,G,B:R,G,B']
cpufetch [--version] [--help] [--levels] [--style fancy|retro|legacy] [--color intel|amd|'R,G,B:R,G,B:R,G,B:R,G,B']
.SH DESCRIPTION
cpufetch will print CPU information, for which will query CPUID instructions and udev directories on Linux as a fallback method. It will display:
cpufetch will print CPU information, for which will query CPUID instructions and udev directories on Linux as a fallback method. Some of this features are:
.IP \[bu] 2
Name
.IP \[bu]
@@ -12,39 +12,46 @@ Frequency
.IP \[bu]
Number of cores (Physical and Logical)
.IP \[bu]
AVX,SSE,FMA,AES,SHA instructions support
.IP \[bu]
Cache sizes
.IP \[bu]
Theoretical peak flops (computed using the max frequency. This is only an approximation, please see https://github.com/Dr-Noob/FLOPS if you are interested in peak performance)
Theoretical peak performance in floating point operations per second (FLOP/s)
.SH OPTIONS
.TP
\fB\-\-style\fR \f[I][R,G,B:R,G,B:R,G,B:R,G,B]\f[]
Set a custom color scheme. 4 colors must be specified in RGB with the format R,G,B:R,G,B:...
Suggested custom color schemes:
\fB\-\-style\fR \f[I][intel|amd|R,G,B:R,G,B:R,G,B:R,G,B]\f[]
Set the color scheme. By default, cpufetch uses the system color scheme. This option lets the user use different colors to print the CPU art:
.IP \[bu]
\fBIntel\fR: --color 15,125,194:230,230,230:40,150,220:230,230,230
\fB"intel"\fR: Use intel color scheme
.IP \[bu]
\fBAMD\fR: --color 250,250,250:0,154,102:250,250,250:0,154,102
\fB"amd"\fR: Use amd color scheme
.IP \[bu]
\fBcustom\fR: If color do not match "intel" or "amd", a custom scheme can be specified: 4 colors must be given in RGB with the format: R,G,B:R,G,B:...
These colors correspond to CPU art color (2 colors) and for the text colors (following 2)
.TP
\fB\-\-style\fR \f[I]STYLE\f[]
Specify the style of ascii logo:
.IP \[bu]
\fBfancy\fR: Default style
\fB"fancy"\fR: Default style
.IP \[bu]
\fBretro\fR: Old cpufetch style
\fB"retro"\fR: Old cpufetch style
.IP \[bu]
\fBlegacy\fR: Fallback style for terminals that does not support colors
.TP
\fB\-\-help\fR
Prints help
\fB"legacy"\fR: Fallback style for terminals that does not support colors
.TP
\fB\-\-levels\fR
Prints CPUID levels and CPU name
.TP
\fB\-\-verbose\fR
Prints extra information (if available) about how cpufetch tried fetching information
.TP
\fB\-\-help\fR
Prints help
.TP
\fB\-\-version\fR
Prints cpufetch version
.SH BUGS
Bugs should be posted on: https://github.com/Dr-Noob/cpufetch/issues
.SH NOTES
Peak performance information is NOT accurate. cpufetch computes peak performance using the max
frequency. However, to properly compute peak performance, you need to know the frequency of the
CPU running AVX code, which is not be fetched by cpufetch since it depends on each specific CPU.
.SH AUTHOR
Dr-Noob (https://github.com/Dr-Noob)