Git repository summary in your terminal
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

173 lines
3.6 KiB

.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.2.
.TH ONEFETCH "1" "November 2022" "onefetch 2.14.2" "User Commands"
.SH NAME
onefetch \- manual page for onefetch 2.14.2
.SH SYNOPSIS
.B onefetch
[\fI\,OPTIONS\/\fR] [\fI\,INPUT\/\fR]
.SH DESCRIPTION
Command\-line Git information tool
.SS "Arguments:"
.IP
[INPUT]
.IP
Run as if onefetch was started in <input> instead of the current working directory
.SH OPTIONS
.HP
\fB\-\-ascii\-input\fR <STRING>
.IP
Takes a non\-empty STRING as input to replace the ASCII logo
.IP
It is possible to pass a generated STRING by command substitution
.IP
For example:
.IP
\&'\-\-ascii\-input "$(fortune | cowsay \fB\-W\fR 25)"
.HP
\fB\-a\fR, \fB\-\-ascii\-language\fR <LANGUAGE>
.IP
Which LANGUAGE's ascii art to print
.HP
\fB\-c\fR, \fB\-\-ascii\-colors\fR <X>...
.IP
Colors (X X X...) to print the ascii art
.HP
\fB\-d\fR, \fB\-\-disabled\-fields\fR <FIELD>...
.IP
Allows you to disable FIELD(s) from appearing in the output
.HP
\fB\-i\fR, \fB\-\-image\fR <IMAGE>
.IP
Path to the IMAGE file
.HP
\fB\-\-image\-protocol\fR <IMAGE_PROTOCOL>
.IP
Which image protocol to use
.IP
[possible values: kitty, sixel, iterm]
.HP
\fB\-\-color\-resolution\fR <VALUE>
.IP
VALUE of color resolution to use with SIXEL backend
.IP
[default: 16]
[possible values: 16, 32, 64, 128, 256]
.HP
\fB\-\-no\-bold\fR
.IP
Turns off bold formatting
.HP
\fB\-\-no\-merges\fR
.IP
Ignores merge commits
.HP
\fB\-\-no\-color\-palette\fR
.IP
Hides the color palette
.HP
\fB\-\-number\-of\-authors\fR <NUM>
.IP
Maximum NUM of authors to be shown
.IP
[default: 3]
.HP
\fB\-\-number\-of\-languages\fR <NUM>
.IP
Maximum NUM of languages to be shown
.IP
[default: 6]
.HP
\fB\-e\fR, \fB\-\-exclude\fR <EXCLUDE>...
.IP
Ignore all files & directories matching EXCLUDE
.HP
\fB\-\-no\-bots\fR [<REGEX>]
.IP
Exclude [bot] commits. Use <REGEX> to override the default pattern
.HP
\fB\-l\fR, \fB\-\-languages\fR
.IP
Prints out supported languages
.HP
\fB\-p\fR, \fB\-\-package\-managers\fR
.IP
Prints out supported package managers
.HP
\fB\-o\fR, \fB\-\-output\fR <FORMAT>
.IP
Outputs Onefetch in a specific format
.IP
[possible values: json, yaml]
.HP
\fB\-\-true\-color\fR <WHEN>
.IP
Specify when to use true color
.IP
If set to auto: true color will be enabled if supported by the terminal
.IP
[default: auto]
[possible values: auto, never, always]
.HP
\fB\-\-show\-logo\fR <WHEN>
.IP
Specify when to show the logo
.IP
If set to auto: the logo will be hidden if the terminal's width < 95
.IP
[default: always]
[possible values: auto, never, always]
.HP
\fB\-t\fR, \fB\-\-text\-colors\fR <X>...
.IP
Changes the text colors (X X X...)
.IP
Goes in order of title, ~, underline, subtitle, colon, and info
.IP
For example:
.IP
\&'\-\-text\-colors 9 10 11 12 13 14'
.HP
\fB\-z\fR, \fB\-\-iso\-time\fR
.IP
Use ISO 8601 formatted timestamps
.HP
\fB\-E\fR, \fB\-\-email\fR
.IP
Show the email address of each author
.HP
\fB\-\-include\-hidden\fR
.IP
Count hidden files and directories
.HP
\fB\-T\fR, \fB\-\-type\fR <TYPE>...
.IP
Filters output by language type
.IP
[default: programming markup]
[possible values: programming, markup, prose, data]
.HP
\fB\-\-generate\fR <SHELL>
.IP
If provided, outputs the completion file for given SHELL
.IP
[possible values: bash, elvish, fish, powershell, zsh]
.HP
\fB\-h\fR, \fB\-\-help\fR
.IP
Print help information (use `\-h` for a summary)
.HP
\fB\-V\fR, \fB\-\-version\fR
.IP
Print version information
.SH "SEE ALSO"
The full documentation for
.B onefetch
is maintained as a Texinfo manual. If the
.B info
and
.B onefetch
programs are properly installed at your site, the command
.IP
.B info onefetch
.PP
should give you access to the complete manual.