forked from dylanaraps/neofetch
-
Notifications
You must be signed in to change notification settings - Fork 0
/
neofetch.1
364 lines (364 loc) · 9.35 KB
/
neofetch.1
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.8.
.TH NEOFETCH "1" "January 2019" "Neofetch 6.0.1" "User Commands"
.SH NAME
Neofetch \- A fast, highly customizable system info script
.SH SYNOPSIS
.B neofetch
\fI\,func_name --option "value" --option "value"\/\fR
.SH DESCRIPTION
Neofetch is a CLI system information tool written in BASH. Neofetch
displays information about your system next to an image, your OS logo,
or any ASCII file of your choice.
.PP
NOTE: Every launch flag has a config option.
.SH OPTIONS
.SS "INFO:"
.TP
func_name
Specify a function name (second part of info() from config) to
quickly display only that function's information.
.IP
Example: neofetch uptime \fB\-\-uptime_shorthand\fR tiny
.IP
Example: neofetch uptime disk wm memory
.IP
This can be used in bars and scripts like so:
.IP
memory="$(neofetch memory)"; memory="${memory##*: }"
.IP
For multiple outputs at once (each line of info in an array):
.IP
IFS=$'\en' read \fB\-d\fR "" \fB\-ra\fR info < <(neofetch memory uptime wm)
.IP
info=("${info[@]##*: }")
.TP
\fB\-\-disable\fR infoname
Allows you to disable an info line from appearing
in the output. 'infoname' is the function name from the
\&'print_info()' function inside the config file.
For example: 'info "Memory" memory' would be '\-\-disable memory'
.IP
NOTE: You can supply multiple args. eg. 'neofetch \fB\-\-disable\fR cpu gpu'
.TP
\fB\-\-package_managers\fR on/tiny/off
Hide/Show Package Manager names . (on, tiny, off)
.TP
\fB\-\-os_arch\fR on/off
Hide/Show OS architecture.
.TP
\fB\-\-speed_type\fR type
Change the type of cpu speed to display.
Possible values: current, min, max, bios,
scaling_current, scaling_min, scaling_max
.IP
NOTE: This only supports Linux with cpufreq.
.TP
\fB\-\-speed_shorthand\fR on/off
Whether or not to show decimals in CPU speed.
.TP
NOTE: This flag is not supported in systems with CPU speed less than
1 GHz.
.TP
\fB\-\-cpu_brand\fR on/off
Enable/Disable CPU brand in output.
.TP
\fB\-\-cpu_cores\fR type
Whether or not to display the number of CPU cores
Possible values: logical, physical, off
.IP
NOTE: 'physical' doesn't work on BSD.
.TP
\fB\-\-cpu_speed\fR on/off
Hide/Show cpu speed.
.TP
\fB\-\-cpu_temp\fR C/F/off
Hide/Show cpu temperature.
.IP
NOTE: This only works on Linux and BSD.
.TP
NOTE: For FreeBSD and NetBSD\-based systems, you need to enable
coretemp kernel module. This only supports newer Intel processors.
.TP
\fB\-\-distro_shorthand\fR on/tiny/off
Shorten the output of distro (on, tiny, off)
.IP
NOTE: This option won't work in Windows (Cygwin)
.TP
\fB\-\-kernel_shorthand\fR on/off
Shorten the output of kernel
.IP
NOTE: This option won't work in BSDs (except PacBSD and PC\-BSD)
.TP
\fB\-\-uptime_shorthand\fR on/tiny/off
Shorten the output of uptime (on, tiny, off)
.TP
\fB\-\-refresh_rate\fR on/off
Whether to display the refresh rate of each monitor
Unsupported on Windows
.TP
\fB\-\-gpu_brand\fR on/off
Enable/Disable GPU brand in output. (AMD/NVIDIA/Intel)
.TP
\fB\-\-gpu_type\fR type
Which GPU to display. (all, dedicated, integrated)
.IP
NOTE: This only supports Linux.
.TP
\fB\-\-gtk_shorthand\fR on/off
Shorten output of gtk theme/icons
.TP
\fB\-\-gtk2\fR on/off
Enable/Disable gtk2 theme/font/icons output
.TP
\fB\-\-gtk3\fR on/off
Enable/Disable gtk3 theme/font/icons output
.TP
\fB\-\-shell_path\fR on/off
Enable/Disable showing $SHELL path
.TP
\fB\-\-shell_version\fR on/off
Enable/Disable showing $SHELL version
.TP
\fB\-\-disk_show\fR value
Which disks to display.
Possible values: '/', '/dev/sdXX', '/path/to/mount point'
.IP
NOTE: Multiple values can be given. (\fB\-\-disk_show\fR '/' '/dev/sdc1')
.TP
\fB\-\-disk_subtitle\fR type
What information to append to the Disk subtitle.
Takes: name, mount, dir
.IP
\&'name' shows the disk's name (sda1, sda2, etc)
.IP
\&'mount' shows the disk's mount point (/, \fI\,/mnt/Local\/\fP Disk, etc)
.IP
\&'dir' shows the basename of the disks's path. (/, Local Disk, etc)
.TP
\fB\-\-ip_host\fR url
URL to query for public IP
.TP
\fB\-\-ip_timeout\fR int
Public IP timeout (in seconds).
.TP
\fB\-\-song_format\fR format
Print the song data in a specific format (see config file).
.TP
\fB\-\-song_shorthand\fR on/off
Print the Artist/Album/Title on separate lines.
.TP
\fB\-\-memory_percent\fR on/off
Display memory percentage.
.TP
\fB\-\-music_player\fR player\-name
Manually specify a player to use.
Available values are listed in the config file
.SS "TEXT FORMATTING:"
.TP
\fB\-\-colors\fR x x x x x x
Changes the text colors in this order:
title, @, underline, subtitle, colon, info
.TP
\fB\-\-underline\fR on/off
Enable/Disable the underline.
.TP
\fB\-\-underline_char\fR char
Character to use when underlining title
.TP
\fB\-\-bold\fR on/off
Enable/Disable bold text
.TP
\fB\-\-separator\fR string
Changes the default ':' separator to the specified string.
.SS "COLOR BLOCKS:"
.TP
\fB\-\-color_blocks\fR on/off
Enable/Disable the color blocks
.TP
\fB\-\-block_width\fR num
Width of color blocks in spaces
.TP
\fB\-\-block_height\fR num
Height of color blocks in lines
.TP
\fB\-\-block_range\fR num num
Range of colors to print as blocks
.SS "BARS:"
.TP
\fB\-\-bar_char\fR 'elapsed char' 'total char'
Characters to use when drawing bars.
.TP
\fB\-\-bar_border\fR on/off
Whether or not to surround the bar with '[]'
.TP
\fB\-\-bar_length\fR num
Length in spaces to make the bars.
.TP
\fB\-\-bar_colors\fR num num
Colors to make the bar.
Set in this order: elapsed, total
.TP
\fB\-\-cpu_display\fR mode
Bar mode.
Possible values: bar, infobar, barinfo, off
.TP
\fB\-\-memory_display\fR mode
Bar mode.
Possible values: bar, infobar, barinfo, off
.TP
\fB\-\-battery_display\fR mode
Bar mode.
Possible values: bar, infobar, barinfo, off
.TP
\fB\-\-disk_display\fR mode
Bar mode.
Possible values: bar, infobar, barinfo, off
.SS "IMAGE BACKEND:"
.TP
\fB\-\-backend\fR backend
Which image backend to use.
Possible values: 'ascii', 'caca', 'chafa', 'jp2a', 'iterm2',
\&'off', 'sixel', 'tycat', 'w3m'
.TP
\fB\-\-source\fR source
Which image or ascii file to use.
Possible values: 'auto', 'ascii', 'wallpaper', '/path/to/img',
\&'/path/to/ascii', '/path/to/dir/', 'command output' [ascii]
.TP
\fB\-\-ascii\fR source
Shortcut to use 'ascii' backend.
.IP
NEW: neofetch \fB\-\-ascii\fR "$(fortune | cowsay \fB\-W\fR 30)"
.TP
\fB\-\-caca\fR source
Shortcut to use 'caca' backend.
.TP
\fB\-\-chafa\fR source
Shortcut to use 'chafa' backend.
.TP
\fB\-\-iterm2\fR source
Shortcut to use 'iterm2' backend.
.TP
\fB\-\-jp2a\fR source
Shortcut to use 'jp2a' backend.
.TP
\fB\-\-kitty\fR source
Shortcut to use 'kitty' backend.
.TP
\fB\-\-pixterm\fR source
Shortcut to use 'pixterm' backend.
.TP
\fB\-\-sixel\fR source
Shortcut to use 'sixel' backend.
.TP
\fB\-\-termpix\fR source
Shortcut to use 'termpix' backend.
.TP
\fB\-\-tycat\fR source
Shortcut to use 'tycat' backend.
.TP
\fB\-\-w3m\fR source
Shortcut to use 'w3m' backend.
.TP
\fB\-\-off\fR
Shortcut to use 'off' backend (Disable ascii art).
.IP
NOTE: 'source; can be any of the following: 'auto', 'ascii', 'wallpaper', '/path/to/img',
\&'/path/to/ascii', '/path/to/dir/'
.SS "ASCII:"
.TP
\fB\-\-ascii_colors\fR x x x x x x
Colors to print the ascii art
.TP
\fB\-\-ascii_distro\fR distro
Which Distro's ascii art to print
.IP
NOTE: Arch and Ubuntu have 'old' logo variants.
.IP
NOTE: Use 'arch_old' or 'ubuntu_old' to use the old logos.
.IP
NOTE: Ubuntu has flavor variants.
.TP
NOTE: Change this to 'Lubuntu', 'Xubuntu', 'Ubuntu\-GNOME',
\&'Ubuntu\-Studio' or 'Ubuntu\-Budgie' to use the flavors.
.TP
NOTE: Alpine, Arch, CRUX, Debian, Gentoo, FreeBSD, Mac, NixOS,
OpenBSD, and Void have a smaller logo variant.
.IP
NOTE: Use '{distro name}_small' to use the small variants.
.TP
\fB\-\-ascii_bold\fR on/off
Whether or not to bold the ascii logo.
.TP
\fB\-L\fR, \fB\-\-logo\fR
Hide the info text and only show the ascii logo.
.SS "IMAGE:"
.TP
\fB\-\-loop\fR
Redraw the image constantly until Ctrl+C is used. This fixes issues
in some terminals emulators when using image mode.
.TP
\fB\-\-size\fR 00px | \fB\-\-size\fR 00%
How to size the image.
Possible values: auto, 00px, 00%, none
.TP
\fB\-\-crop_mode\fR mode
Which crop mode to use
Takes the values: normal, fit, fill
.TP
\fB\-\-crop_offset\fR value
Change the crop offset for normal mode.
Possible values: northwest, north, northeast,
west, center, east, southwest, south, southeast
.TP
\fB\-\-xoffset\fR px
How close the image will be to the left edge of the
window. This only works with w3m.
.TP
\fB\-\-yoffset\fR px
How close the image will be to the top edge of the
window. This only works with w3m.
.TP
\fB\-\-bg_color\fR color
Background color to display behind transparent image.
This only works with w3m.
.TP
\fB\-\-gap\fR num
Gap between image and text.
.TP
NOTE: \fB\-\-gap\fR can take a negative value which will move the text
closer to the left side.
.TP
\fB\-\-clean\fR
Delete cached files and thumbnails.
.SS "OTHER:"
.TP
\fB\-\-config\fR \fI\,/path/to/config\/\fP
Specify a path to a custom config file
.TP
\fB\-\-config\fR none
Launch the script without a config file
.TP
\fB\-\-print_config\fR
Print the default config file to stdout.
.TP
\fB\-\-stdout\fR
Turn off all colors and disables any ASCII/image backend.
.TP
\fB\-\-help\fR
Print this text and exit
.TP
\fB\-\-version\fR
Show neofetch version
.TP
\fB\-v\fR
Display error messages.
.TP
\fB\-vv\fR
Display a verbose log for error reporting.
.SS "DEVELOPER:"
.TP
\fB\-\-gen\-man\fR
Generate a manpage for Neofetch in your PWD. (Requires GNU help2man)
.SH "REPORTING BUGS"
Report bugs to https://github.com/dylanaraps/neofetch/issues