Add man page install to makefile, lowercase all values in manpage and update changelog

This commit is contained in:
Dylan 2016-03-05 09:21:57 +11:00
parent e4ff09b2df
commit ba0f7554f7
3 changed files with 49 additions and 46 deletions

1
1.4.md
View file

@ -1,6 +1,7 @@
# Neofetch 1.4
- Renamed `fetch` to `neofetch`. Thanks for voting.
- Fetch now has a man page. (man neofetch) Thanks **[@konimex](https://github.com/konimex)**
### Packages

View file

@ -11,11 +11,13 @@ install:
$(INSTALL_DIR) $(DESTDIR)$(PREFIX)/bin
$(INSTALL_DIR) $(DESTDIR)$(PREFIX)/share/neofetch/ascii/distro
$(INSTALL_PROG) neofetch $(DESTDIR)$(PREFIX)/bin/neofetch
$(INSTALL_PROG) neofetch.1 $(DESTDIR)$(PREFIX)/share/man/man1/neofetch.1
$(INSTALL_PROG) config/config $(DESTDIR)$(PREFIX)/share/neofetch/config
$(INSTALL_PROG) ascii/distro/* $(DESTDIR)$(PREFIX)/share/neofetch/ascii/distro
uninstall:
$(RM) $(DESTDIR)$(PREFIX)/bin/neofetch
$(RM) $(DESTDIR)$(PREFIX)/share/man/man1/neofetch.1
$(RM) -r $(DESTDIR)$(PREFIX)/share/neofetch

View file

@ -3,29 +3,29 @@
neofetch \- simple system information script
.SH SYNOPSIS
.B neofetch \fR[OPTIONAL FLAGS]
.B neofetch \fR[Optional Flags]
.SH DESCRIPTION
neofetch is a script that gathers information about your system and prints
neofetch is a script that gathers information about your system and prints
it to the terminal next to an image, a distro's logo or any ASCII art of
your choice.
.SH OPTIONS
.TP
.B \--disable 'INFONAME'
.B \--disable 'infoname'
Allows you to disable an info line from appearing in the output.
.br
NOTE: You can supply multiple args. eg.
.br
\'neofetch --disable cpu gpu disk shell\'
.TP
.B \--osx_buildversion 'ON/OFF'
.B \--osx_buildversion 'on/off'
Hide/Show Mac OS X build version.
.TP
.B \--os_arch 'ON/OFF'
.B \--os_arch 'on/off'
Hide/Show Windows architecture.
.TP
.B \--speed_type 'TYPE'
.B \--speed_type 'type'
Change the type of cpu speed to display.
.br
Possible values: current, min, max, bios,
@ -33,46 +33,46 @@ scaling_current, scaling_min, scaling_max
.br
NOTE: This only support Linux with cpufreq.
.TP
.B \--kernel_shorthand 'ON/OFF'
.B \--kernel_shorthand 'on/off'
Shorten the output of kernel
.TP
.B \--uptime_shorthand 'ON/OFF'
.B \--uptime_shorthand 'on/off'
Shorten the output of uptime (tiny, on, off)
.TP
.B \--gpu_shorthand 'ON/OFF'
.B \--gpu_shorthand 'on/off'
Shorten the output of GPU
.TP
.B \--gtk_shorthand 'ON/OFF'
.B \--gtk_shorthand 'on/off'
Shorten output of gtk theme/icons
.TP
.B \--gtk2 'ON/OFF'
.TP
.B \--gtk2 'on/off'
Enable/Disable GTK2 theme/icons output
.TP
.B \--gtk3 'ON/OFF'
.B \--gtk3 'on/off'
Enable/Disable gtk3 theme/icons output
.TP
.B \--shell_path 'ON/OFF'
.B \--shell_path 'on/off'
Enable/Disable showing \$SHELL path
.TP
.B \--shell_version 'ON/OFF'
.B \--shell_version 'on/off'
Enable/Disable showing \$SHELL version
.TP
.B \--battery_num 'NUM'
.B \--battery_num 'num'
Which battery to display, default value is 'all'
.TP
.B \--battery_shorthand 'ON/OFF'
.B \--battery_shorthand 'on/off'
Whether or not each battery gets its own line/title
.TP
.B \--ip_host 'URL'
.B \--ip_host 'url'
URL to ping for public IP
.TP
.B \--song_shorthand 'ON/OFF'
.B \--song_shorthand 'on/off'
Print the Artist/Title on seperate lines
.TP
.B \--birthday_shorthand 'ON/OFF'
.B \--birthday_shorthand 'on/off'
Shorten the output of birthday
.TP
.B \--birthday_time 'ON/OFF'
.B \--birthday_time 'on/off'
Enable/Disable showing the time in birthday output
.SH TEXT COLORS
@ -83,68 +83,68 @@ title, @, underline, subtitle, colon, info
.SH TEXT FORMATTING
.TP
.B \--underline_char 'CHAR'
.B \--underline_char 'char'
Character to use when underlining title
.TP
.B \--line_wrap 'ON/OFF'
.B \--line_wrap 'on/off'
Enable/Disable line wrapping
.TP
.B \--bold 'ON/OFF'
.B \--bold 'on/off'
Enable/Disable bold text
.TP
.B \--prompt_height 'NUM'
.B \--prompt_height 'num'
Set this to your prompt height to fix issues
with the text going off screen at the top
.SH COLOR BLOCKS
.TP
.B \--color_blocks 'ON/OFF'
.B \--color_blocks 'on/off'
Enable/Disable the color blocks
.TP
.B \--block_width 'NUM'
.B \--block_width 'num'
Width of color blocks
.TP
.B \--block_range 'START' 'END'
.B \--block_range 'start' 'end'
Range of colors to print as blocks
.SH IMAGE
.TP
.B \--image 'TYPE'
.B \--image 'type'
Image source. Where and what image we display.
.br
Possible values: wall, shuffle, ascii, /path/to/img, off
.TP
.B \--size 'SIZE'
.B \--size 'size'
Size to make the image, takes pixels or a percentage.
.TP
.B \--image_backend 'w3m/iterm2'
Which program to use to draw images.
.TP
.B \--shuffle_dir 'PATH'
.B \--shuffle_dir 'path'
Which directory to shuffle for an image.
.TP
.B \--image_position 'LEFT/RIGHT'
.B \--image_position 'left/right'
Where to display the image: (Left/Right)
.TP
.B \--crop_mode 'MODE'
.B \--crop_mode 'mode'
Which crop mode to use
.br Takes the values: normal, fit, fill
.TP
.B \--crop_offset 'VALUE'
.B \--crop_offset 'value'
Change the crop offset for normal mode.
.br
Possible values: northwest, north, northeast,
west, center, east, southwest, south, southeast
.TP
.B \--xoffset 'VALUE'
.B \--xoffset 'value'
How close the image will be to the left edge of the
window in pixel. This only works with w3m.
.TP
.B \--yoffset 'VALUE'
.B \--yoffset 'value'
How close the image will be to the top edge
of the window. This only works with w3m.
.TP
.B \--gap 'NUM'
.B \--gap 'num'
Gap between image and text.
.br
NOTE: --gap can take a negative value which
@ -155,15 +155,15 @@ Remove all cropped images
.SH ASCII
.TP
.B \--ascii 'VALUE'
.B \--ascii 'value'
Where to get the ASCII from
.br
Possible values: distro, /path/to/ascii
.TP
.B \--ascii_color 'NUM'
.B \--ascii_color 'num'
Color to print the ASCII art
.TP
.B \--ascii_distro 'DISTRO'
.B \--ascii_distro 'distro'
Which Distro\'s ASCII art to print
.SH STDOUT
@ -172,19 +172,19 @@ Which Distro\'s ASCII art to print
Launch fetch in stdout mode which prints the info in
a plain-text format that you can use with lemonbar etc.
.TP
.B \--stdout_title 'ON/OFF'
.B \--stdout_title 'on/off'
Hide/Show the title in stdout mode.
.TP
.B \--stdout_separator 'STRING'
.B \--stdout_separator 'string'
String to use as a separator in stdout mode.
.TP
.B \--stdout_subtitles 'ON/OFF'
.B \--stdout_subtitles 'on/off'
Hide/Show the subtitles in stdout mode.
.SH SCREENSHOT
.TP
.B \--scrot 'PATH'
.B \--scrot 'path'
Take a screenshot, if path is left empty the screenshot
function will use \$scrot_dir and \$scrot_name.
.TP
@ -193,13 +193,13 @@ Screenshot program to launch
.SH OTHER
.TP
.B \--config 'PATH'
.B \--config 'path'
Specify a path to a custom config file
.TP
.B \--config none
Launch the script without a config file
.TP
.B \--help
.B \--help
.SH "SEE ALSO"
http://github.com/dylanaraps/neofetch