errorgen/Command Line Interface.txt

160 lines
4.4 KiB
Plaintext

NAME:
errorgen - make fun and custom error messages.
USAGE:
errorgen [global options] command [command options] [arguments...]
AUTHOR:
Noah Petherbridge, https://www.kirsle.net
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--version, -v Show program version and build information and exit. (default: false)
--error, -e Make the dialog box be of type 'error' by default.
An info box has these default attributes unless overridden by
other options:
Title: Error
Text: An error has occurred.
Icon: error
Buttons: Ok (default: false)
--alert, -a Make the dialog box be of type 'alert' by default.
An alert box has these default attributes unless overridden by
other options:
Title: Warning
Text: Are you sure you want to proceed?
Icon: attention
Buttons: Ok (default: false)
--info, -i Make the dialog box be of type 'info' by default.
An info box has these default attributes unless overridden by
other options:
Title: Information
Text: All updates are complete.
Icon: info
Buttons: Ok (default: false)
--question, -q Make the dialog box be of type 'question' by default.
A question box has these default attributes unless overridden by
other options:
Title: Question
Text: Are you sure you want to proceed?
Icon: question
Buttons: Ok, Cancel (default: false)
--title value, -n value Set the title for the dialog box.
If no title is set, a default is used based on the type of dialog
box requested (which is --info by default; see also --error,
--info, --question)
--text value, -t value The text displayed inside the dialog box.
Use \n where you want line breaks.
Important: the text does NOT have automatic word wrapping applied.
Insert your own line breaks or else the dialog can be VERY wide for
longer messages!
--button value, -b value Add a button to the dialog.
Use this option as many times as you want to add multiple buttons.
The one the user chooses will be printed to standard output. If no
buttons, default is an Ok button. (accepts multiple inputs)
--default value, -m value Set the default button by its label.
The matching --button will be made the default/primary button.
--cancel value, -c value Set the 'cancel button'.
This value should match one of your --buttons and will be the
value 'selected' if the user closes the window or hits the
Escape key.
--disabled value, -d value, -g value Mark buttons (by index) disabled
Specify a --button number (from 0 to n) that should be disabled,
or greyed out. The user can not click on this button. (accepts multiple inputs)
--icon value, -o value Set the icon to be displayed in the dialog box.
Use either a built-in icon by name (e.g. "aim_guy") or name your
own custom PNG image from disk.
Built-in icon names include the following:
aim_guy
aol_icon
attention
bomb
bomb_dynamite
bomb_grenade
bubble_i
bubble_q
bulb
butterfly
cake
circularsaw
control_panel
cow
defrag
disk_blu
disk_blu_lbl
disk_org
disk_red
disk_red_lbl
disk_skull
disk_yel
dos
e_orbit
error
error2
error3
error4
file_cabinet
find
fortunecookie
garbage_empty
garbage_full
gun
hammer
heart
help
hub
hwinfo
ic_a
keys
keys2
keys3
labtec
mac
mail
mail_deleted
mailbox
mouth
mycomputer
mycomputer2
mycomputer3
newspaper
peripheral
plant_leaf
radiation
ram
recycle
recycle2
scanner
screw
screw2
setup
sknife
skull
skull2
skull3
tux
tux_config
ups
zipdisk
zipdisks
--help, -h show help (default: false)