Skip to content

Commit 6e1efdd

Browse files
committed
update help argument for awesomeshot v.1.0.7
1 parent 2b27d37 commit 6e1efdd

File tree

1 file changed

+118
-6
lines changed

1 file changed

+118
-6
lines changed

awesomeshot

+118-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
#
66
# Copyright (c) 2021 - 2022 xShin
77

8-
version=1.0.6
8+
version=1.0.7
99

1010
XDG_CONFIG_HOME=${XDG_CONFIG_HOME:-${HOME}/.config}
1111
config_file="${XDG_CONFIG_HOME}/awesomeshot/awesomeshot.conf"
@@ -566,13 +566,125 @@ function help() {
566566
awesomeshot [args] [file]
567567
568568
META OPTIONS:
569-
-h, --help Show list of command-line options
570-
-v, --version Show version of awesomeshot
569+
-h, --help Show list of command-line options
570+
-v, --version Show version of awesomeshot
571571
572572
RUN OPTIONS:
573-
-a, --auto Run awesomeshot with automatic while take screenshot
574-
-m, --manual Run awesomeshot with manual (this option require filename)
575-
-c, --config Generate default config awesomeshot.conf
573+
-a, --auto Run awesomeshot with automatic while take screenshot
574+
-m, --manual Run awesomeshot with manual (this option require filename)
575+
-c, --config Generate default config awesomeshot.conf
576+
577+
CONFIG OPTIONS:
578+
screenshot_result_path Make sure when your phone screenshot the result file image
579+
PATH is same with this variable. Default my phone result file
580+
image PATH on '/sdcard/DCIM/Screenshots'. If not same,
581+
you can edit this variable value
582+
583+
convert_to_png This variable serves to set the convert image with file type non PNG, change this value
584+
to blank or whatever for disable function and 'yes' for enable function.
585+
Convert to PNG if file not PNG
586+
587+
backup This variable serves to function to backup original photo
588+
(screenshot result), change this value to blank or whatever for disable
589+
function and 'yes' for enable function
590+
591+
path_backup This variable serves to set the original photo backup PATH
592+
593+
hex_color Array Hex Color
594+
595+
convert_titlebar This variable serves to convert title bar when editing the image, change this value
596+
to blank or whatever for disable convert and 'yes' for enable function
597+
598+
add_on_img This variable serves to set where the title bar place, if 'yes' the title bar add on image,
599+
if blank or whatever the title bar will be added at out of image
600+
601+
width_img & height_img This variable serves to set the width and height size of title bar.
602+
NOTE (Bug Found):
603+
- Sometimes the title bar result is too big or too small
604+
width_img=magick file_name - format '%w' info:
605+
height_img=magick file_name - format '%h' info:
606+
if (( width_img > height_img )); then
607+
height_img=width_img
608+
elif (( width_img < height_img )); then
609+
width_img=height_img
610+
fi
611+
612+
titlebar_color This variable serves to set titlebar color, if you want to custom the color, you can
613+
change this value with hex color or use the one in the array list.
614+
615+
convert_rounded This variable serves to convert rounded corner, change this value
616+
to blank or whatever for disable convert and 'yes' for enable function
617+
618+
border_radius This variable serves to set how many rounded corners
619+
620+
convert_first_border This variable serves to convert tiny first border (background image) when editing the image,
621+
change this value to blank or whatever for disable convert and 'yes' for enable function
622+
623+
first_border_color This variable serves to set tiny first border color (background image), change this value
624+
to 'none' for transparent background, if you want to custom the color, you can
625+
change this value with hex color or use the one in the array list.
626+
627+
first_border_size This variable serves to set how many size of the first border
628+
NOTE: make sure this value is small, otherwise it will look weird
629+
630+
convert_second_border This variable serves to convert border (background image) when editing the image,
631+
change this value to blank or whatever for disable convert and 'yes' for enable function
632+
633+
second_border_color This variable serves to set border color (background image), change this value
634+
to 'none' for transparent background, if you want to custom the color, you can
635+
change this value with hex color or use the one in the array list.
636+
637+
second_border_size This variable serves to set how many size of the second border
638+
639+
convert_shadow This variable serves to convert the shadow of image, change this value
640+
to blank or whatever for disable function and 'yes' for enable function.
641+
642+
shadow_color This variable serves to set shadow color, if you want to custom the color, you can
643+
change this value with hex color or use the one in the array list.
644+
645+
shadow_size This variable serves to set shadow size, this variable has four values:
646+
shadow_size='75x30+0+30'
647+
that mean:
648+
- bottom shadow is x75
649+
- right shadow is +30
650+
- top shadow is +0
651+
- left shadow is +30
652+
653+
convert_footer This variable serves to convert the footer text, change this value
654+
to blank or whatever for disable function and 'yes' for enable function.
655+
656+
footer_text This variable serves to set text of footer, if you want to use icon
657+
you can search on Nerd Fonts Website (https://www.nerdfonts.com/cheat-sheet)
658+
NOTE: if you use icon from Nerd Fonts, make sure 'footer_font' using nerd fonts to!
659+
660+
footer_position This variable serves to set text position of footer, the value contain 8 wind direction:
661+
- NorthWest
662+
- North
663+
- West
664+
- Center
665+
- East
666+
- SouthWest
667+
- South
668+
- SouthEast
669+
NOTE: Default value is 'South'
670+
671+
footer_xy This variable serves to set position of 'X' and 'Y'
672+
673+
footer_font This variable serves to set the font used when converting, you can check the list font
674+
available to use for ImageMagick by command:
675+
magick convert -list font | grep -iE 'font:.*'
676+
677+
footer_font_size This variable serves to set font size
678+
679+
footer_foreground This variable serves to set the text color, if you want to custom the color, you can
680+
change this value with hex color or use the one in the array list.
681+
682+
footer_background This variable serves to set footer background color (background text), change this value
683+
to 'none' for transparent background, if you want to custom the color, you can
684+
change this value with hex color or use the one in the array list.
685+
686+
open_image This variable serves to open the result of image (when editing finished), change this value
687+
to blank or whatever for disable function and 'yes' for enable function.
576688
"
577689
}
578690

0 commit comments

Comments
 (0)