Config: rewrite docs

This commit is contained in:
Dylan Araps 2016-11-26 11:34:45 +11:00
parent 7e098f4f06
commit bef0158649

View file

@ -564,33 +564,47 @@ background_color=
# Default ascii image to use # Default ascii image to use
# When this is set to distro it will use your # When this is set to distro it will use your
# distro's logo as the ascii. # distro's logo as the ascii.
# --ascii 'distro', path/to/ascii #
# Default: 'distro'
# Values: 'distro', '/path/to/ascii_file'
# Flag: --ascii
ascii="distro" ascii="distro"
# Ascii distro # Ascii distro
# Which distro's ascii art to display. # Which distro's ascii art to display.
# --ascii_distro 'auto', 'distro_name' #
# Default: 'auto'
# Values: 'auto', 'distro_name'
# Flag: --ascii_distro
ascii_distro="auto" ascii_distro="auto"
# Ascii colors # Ascii Colors
# When this is set to distro it will use your #
# ditro's colors to color the ascii. # Default: 'distro'
# NOTE: You can also set this to a range of colors # Values: 'distro', 'num' 'num' 'num' 'num' 'num' 'num'
# which will allow you to custom color distro logos # Flag: --ascii_colors
# --ascii_colors distro #
# --ascii_colors 2 4 5 6 # Example:
# ascii_colors=(distro) - Ascii is colored based on Distro colors.
# ascii_colors=(4 6 1 8 8 6) - Ascii is colored using these colors.
ascii_colors=(distro) ascii_colors=(distro)
# Logo size # Logo size
# Arch, Crux and Gentoo have a smaller logo # Arch, Crux and Gentoo have a smaller logo
# variant. Changing the value below to small # variant. Changing the value below to small
# will make neofetch use the small logo. # will make neofetch use the small logo.
# --ascii_logo_size small, normal #
# Default: 'normal'
# Values: 'normal', 'small'
# Flag: --ascii_logo_size
ascii_logo_size="normal" ascii_logo_size="normal"
# Bold ascii logo # Bold ascii logo
# Whether or not to bold the ascii logo. # Whether or not to bold the ascii logo.
# --ascii_bold on, off #
# Default: 'on'
# Values: 'on', 'off'
# Flag: --ascii_bold
ascii_bold="on" ascii_bold="on"
@ -599,25 +613,46 @@ ascii_bold="on"
# Whether or not to always take a screenshot # Whether or not to always take a screenshot
# You can manually take a screenshot with "--scrot" or "-s" # You can manually take a screenshot with "--scrot" or "-s"
#
# Default: 'off'
# Values: 'on', 'off'
# Flags: --scrot
# -s
scrot="off" scrot="off"
# Screenshot program to launch # Screenshot program to launch
# --scrot_cmd # If you're not using 'scrot' change this to your screenshot
# program.
#
# Default: 'scrot -c -d 3'
# Values: 'cmd -flags'
# Flag: --scrot_cmd
scrot_cmd="scrot -c -d 3" scrot_cmd="scrot -c -d 3"
# Scrot dir # Scrot dir
# Where to save the screenshots # Where to save the screenshots
# --scrot_dir /path/to/screenshot/folder #
# Default: '~/Pictures/'
# Values: 'dir'
# Flag: --scrot_dir
#
# Note: Neofetch won't create the directory if it doesn't exist.
scrot_dir="$HOME/Pictures/" scrot_dir="$HOME/Pictures/"
# Scrot filename # Scrot filename
# What to name the screenshots # What to name the screenshots
# --scrot_name str #
# Default: 'neofetch-$(date +%F-%I-%M-%S-${RANDOM}).png'
# Values: 'string'
# Flag: --scrot_name
scrot_name="neofetch-$(date +%F-%I-%M-%S-${RANDOM}).png" scrot_name="neofetch-$(date +%F-%I-%M-%S-${RANDOM}).png"
# Image upload host # Image upload host
# Where to upload the image. # Where to upload the image.
# Possible values: imgur, teknik #
# Default: 'imgur'
# Values: 'imgur', 'teknik'
# Flag: --image_host
image_host="imgur" image_host="imgur"
@ -625,9 +660,24 @@ image_host="imgur"
# Enable/Disable config file # Enable/Disable config file
#
# Default: 'on'
# Values: 'on', 'off'
# Flag: --config
# --config off, none # --config off, none
#
# Note: This option is only used when neofetch sources this config
# as a default config and NOT as a user config. Changing this in
# your user config won't actually do anything.
config="on" config="on"
# Path to custom config file location # Path to custom config file location
# --config path/to/config #
# Default: '${XDG_CONFIG_HOME:-${HOME}/.config}/neofetch/config'
# Values: '/path/to/config'
# Flag: --config_file
#
# Note: This option is only used when neofetch sources this config
# as a default config and NOT as a user config. Changing this in
# your user config won't actually do anything.
config_file="${XDG_CONFIG_HOME:-${HOME}/.config}/neofetch/config" config_file="${XDG_CONFIG_HOME:-${HOME}/.config}/neofetch/config"