|
1 | | -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.48.4. |
2 | | -.TH ONEFETCH "1" "March 2022" "onefetch 2.12.0" "User Commands" |
| 1 | +.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.2. |
| 2 | +.TH ONEFETCH "1" "October 2022" "onefetch 2.13.0" "User Commands" |
3 | 3 | .SH NAME |
4 | | -onefetch \- manual page for onefetch 2.12.0 |
| 4 | +onefetch \- manual page for onefetch 2.13.0 |
| 5 | +.SH SYNOPSIS |
| 6 | +.B onefetch |
| 7 | +[\fI\,OPTIONS\/\fR] [\fI\,INPUT\/\fR] |
5 | 8 | .SH DESCRIPTION |
6 | | -onefetch 2.12.0 |
7 | | -Git repository summary on your terminal |
8 | | -.SS "USAGE:" |
9 | | -.IP |
10 | | -onefetch [OPTIONS] [\-\-] [input] |
11 | | -.SS "ARGS:" |
| 9 | +A command\-line Git information tool |
| 10 | +.SS "Arguments:" |
12 | 11 | .IP |
13 | | -<input> |
| 12 | +[INPUT] |
14 | 13 | .IP |
15 | | -Run as if onefetch was started in <input> instead of the current working directory. |
16 | | -.SS "OPTIONS:" |
| 14 | +Run as if onefetch was started in <input> instead of the current working directory |
| 15 | +.SH OPTIONS |
17 | 16 | .HP |
18 | | -\fB\-o\fR, \fB\-\-output\fR <FORMAT> |
| 17 | +\fB\-\-ascii\-input\fR <STRING> |
| 18 | +.IP |
| 19 | +Takes a non\-empty STRING as input to replace the ASCII logo |
| 20 | +.IP |
| 21 | +It is possible to pass a generated STRING by command substitution |
| 22 | +.IP |
| 23 | +For example: |
19 | 24 | .IP |
20 | | -Outputs Onefetch in a specific format (json, yaml). |
| 25 | +\&'\-\-ascii\-input "$(fortune | cowsay \fB\-W\fR 25)' |
21 | 26 | .HP |
22 | | -\fB\-l\fR, \fB\-\-languages\fR |
| 27 | +\fB\-a\fR, \fB\-\-ascii\-language\fR <LANGUAGE> |
23 | 28 | .IP |
24 | | -Prints out supported languages. |
| 29 | +Which LANGUAGE's ascii art to print |
25 | 30 | .HP |
26 | | -\fB\-p\fR, \fB\-\-package\-managers\fR |
| 31 | +\fB\-c\fR, \fB\-\-ascii\-colors\fR <X>... |
27 | 32 | .IP |
28 | | -Prints out supported package managers. |
| 33 | +Colors (X X X...) to print the ascii art |
29 | 34 | .HP |
30 | | -\fB\-\-show\-logo\fR <WHEN> |
| 35 | +\fB\-d\fR, \fB\-\-disabled\-fields\fR <FIELD>... |
31 | 36 | .IP |
32 | | -Specify when to show the logo (auto, never, *always*). |
33 | | -If set to auto: the logo will be hidden if the terminal's width < 95. |
| 37 | +Allows you to disable FIELD(s) from appearing in the output |
34 | 38 | .HP |
35 | 39 | \fB\-i\fR, \fB\-\-image\fR <IMAGE> |
36 | 40 | .IP |
37 | | -Path to the IMAGE file. |
| 41 | +Path to the IMAGE file |
38 | 42 | .HP |
39 | | -\fB\-\-image\-backend\fR <BACKEND> |
| 43 | +\fB\-\-image\-protocol\fR <IMAGE_PROTOCOL> |
| 44 | +.IP |
| 45 | +Which image protocol to use |
40 | 46 | .IP |
41 | | -Which image BACKEND to use. |
| 47 | +[possible values: kitty, sixel, iterm] |
42 | 48 | .HP |
43 | 49 | \fB\-\-color\-resolution\fR <VALUE> |
44 | 50 | .IP |
45 | | -VALUE of color resolution to use with SIXEL backend. |
46 | | -.HP |
47 | | -\fB\-a\fR, \fB\-\-ascii\-language\fR <LANGUAGE> |
| 51 | +VALUE of color resolution to use with SIXEL backend |
48 | 52 | .IP |
49 | | -Which LANGUAGE's ascii art to print. |
| 53 | +[default: 16] |
| 54 | +[possible values: 16, 32, 64, 128, 256] |
50 | 55 | .HP |
51 | | -\fB\-\-ascii\-input\fR <STRING> |
52 | | -.IP |
53 | | -Takes a non\-empty STRING as input to replace the ASCII logo. It is possible to pass a |
54 | | -generated STRING by command substitution. |
55 | | -For example: |
| 56 | +\fB\-\-no\-bold\fR |
56 | 57 | .IP |
57 | | -\&'\-\-ascii\-input "$(fortune | cowsay \fB\-W\fR 25)"' |
| 58 | +Turns off bold formatting |
58 | 59 | .HP |
59 | | -\fB\-\-true\-color\fR <WHEN> |
| 60 | +\fB\-\-no\-merges\fR |
60 | 61 | .IP |
61 | | -Specify when to use true color (*auto*, never, always). |
62 | | -If set to auto: true color will be enabled if supported by the terminal. |
| 62 | +Ignores merge commits |
63 | 63 | .HP |
64 | | -\fB\-c\fR, \fB\-\-ascii\-colors\fR <X>... |
| 64 | +\fB\-\-no\-color\-palette\fR |
65 | 65 | .IP |
66 | | -Colors (X X X...) to print the ascii art. |
| 66 | +Hides the color palette |
67 | 67 | .HP |
68 | | -\fB\-t\fR, \fB\-\-text\-colors\fR <X>... |
| 68 | +\fB\-n\fR, \fB\-\-number\-of\-authors\fR <NUM> |
69 | 69 | .IP |
70 | | -Changes the text colors (X X X...). Goes in order of title, ~, underline, subtitle, |
71 | | -colon, and info. |
72 | | -For example: |
| 70 | +NUM of authors to be shown |
73 | 71 | .IP |
74 | | -\&'\-\-text\-colors 9 10 11 12 13 14' |
| 72 | +[default: 3] |
75 | 73 | .HP |
76 | | -\fB\-\-no\-bold\fR |
| 74 | +\fB\-e\fR, \fB\-\-exclude\fR <EXCLUDE>... |
77 | 75 | .IP |
78 | | -Turns off bold formatting. |
| 76 | +gnore all files & directories matching EXCLUDE |
79 | 77 | .HP |
80 | | -\fB\-\-no\-palette\fR |
| 78 | +\fB\-\-no\-bots\fR [<REGEX>] |
81 | 79 | .IP |
82 | | -Hides the color palette. |
| 80 | +Exclude [bot] commits. Use <REGEX> to override the default pattern |
83 | 81 | .HP |
84 | | -\fB\-\-no\-merges\fR |
| 82 | +\fB\-l\fR, \fB\-\-languages\fR |
85 | 83 | .IP |
86 | | -Ignores merge commits. |
| 84 | +Prints out supported languages |
87 | 85 | .HP |
88 | | -\fB\-\-no\-bots\fR [<REGEX>...] |
| 86 | +\fB\-p\fR, \fB\-\-package\-managers\fR |
89 | 87 | .IP |
90 | | -Exclude [bot] commits. Use <REGEX> to override the default pattern. |
| 88 | +Prints out supported package managers |
91 | 89 | .HP |
92 | | -\fB\-z\fR, \fB\-\-isotime\fR |
| 90 | +\fB\-o\fR, \fB\-\-output\fR <FORMAT> |
| 91 | +.IP |
| 92 | +Outputs Onefetch in a specific format |
93 | 93 | .IP |
94 | | -Use ISO 8601 formatted timestamps. |
| 94 | +[possible values: json, yaml] |
95 | 95 | .HP |
96 | | -\fB\-d\fR, \fB\-\-disable\-fields\fR <FIELD>... |
| 96 | +\fB\-\-true\-color\fR <WHEN> |
97 | 97 | .IP |
98 | | -Allows you to disable FIELD(s) from appearing in the output. |
| 98 | +Specify when to use true color |
| 99 | +.IP |
| 100 | +If set to auto: true color will be enabled if supported by the terminal |
| 101 | +.IP |
| 102 | +[default: auto] |
| 103 | +[possible values: auto, never, always] |
99 | 104 | .HP |
100 | | -\fB\-A\fR, \fB\-\-authors\-number\fR <NUM> |
| 105 | +\fB\-\-show\-logo\fR <WHEN> |
101 | 106 | .IP |
102 | | -NUM of authors to be shown. |
| 107 | +Specify when to show the logo |
103 | 108 | .IP |
104 | | -[default: 3] |
| 109 | +If set to auto: the logo will be hidden if the terminal's width < 95 |
| 110 | +.IP |
| 111 | +[default: always] |
| 112 | +[possible values: auto, never, always] |
105 | 113 | .HP |
106 | | -\fB\-E\fR, \fB\-\-email\fR |
| 114 | +\fB\-t\fR, \fB\-\-text\-colors\fR <X>... |
107 | 115 | .IP |
108 | | -show the email address of each author. |
| 116 | +Changes the text colors (X X X...) |
| 117 | +.IP |
| 118 | +Goes in order of title, ~, underline, subtitle, colon, and info |
| 119 | +.IP |
| 120 | +For example: |
| 121 | +.IP |
| 122 | +\&'\-\-text\-colors 9 10 11 12 13 14' |
109 | 123 | .HP |
110 | | -\fB\-\-hidden\fR |
| 124 | +\fB\-z\fR, \fB\-\-iso\-time\fR |
111 | 125 | .IP |
112 | | -Count hidden files and directories. |
| 126 | +Use ISO 8601 formatted timestamps |
113 | 127 | .HP |
114 | | -\fB\-e\fR, \fB\-\-exclude\fR <EXCLUDE>... |
| 128 | +\fB\-E\fR, \fB\-\-email\fR |
115 | 129 | .IP |
116 | | -Ignore all files & directories matching EXCLUDE. |
| 130 | +Show the email address of each author |
| 131 | +.HP |
| 132 | +\fB\-\-include\-hidden\fR |
| 133 | +.IP |
| 134 | +Count hidden files and directories |
117 | 135 | .HP |
118 | 136 | \fB\-T\fR, \fB\-\-type\fR <TYPE>... |
119 | 137 | .IP |
120 | | -Filters output by language type (*programming*, *markup*, prose, data). |
| 138 | +Filters output by language type |
| 139 | +.IP |
| 140 | +[default: programming markup] |
| 141 | +[possible values: programming, markup, prose, data] |
| 142 | +.HP |
| 143 | +\fB\-\-generate\fR <SHELL> |
| 144 | +.IP |
| 145 | +If provided, outputs the completion file for given SHELL |
| 146 | +.IP |
| 147 | +[possible values: bash, elvish, fish, powershell, zsh] |
121 | 148 | .HP |
122 | 149 | \fB\-h\fR, \fB\-\-help\fR |
123 | 150 | .IP |
124 | | -Print help information |
| 151 | +Print help information (use `\-h` for a summary) |
125 | 152 | .HP |
126 | 153 | \fB\-V\fR, \fB\-\-version\fR |
127 | 154 | .IP |
|
0 commit comments