forked from Awesomesh0t/awesomeshot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathawesomeshot.1
364 lines (314 loc) · 8.2 KB
/
awesomeshot.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
.TH AWESOMESHOT 1 "26 April 2022" "Awesomeshot 1.0.9" "User Commands"
.SH NAME
Awesomeshot
.SH SYNOPSIS
.B awesomeshot
\fI\,[args] [file]\/\fR
.SH DESCRIPTION
Awesomeshot \- A command-line screenshot tool written in bash 5.1.16+
.SH "HOW AWESOMESHOT WORK?"
\fI\,https://github.com/mayTermux/awesomeshot/issues/2#issuecomment-1052047095\/\fR
.SH "WIKI OR DOCS"
\fI\,https://github.com/mayTermux/awesomeshot/wiki\/\fR
.SH "REPORTING BUGS"
Report bugs to
.IP
\fI\,https://github.com/mayTermux/awesomeshot/issues\/\fR
.SH "SHOWCASE"
Upload your custom config or script
.IP
\fI\,https://github.com/mayTermux/awesomeshot/issues/4\/\fR
.SH META OPTIONS
\fB\-h, \-\-help\fR
.IP
Show list of command-line options
.TP
\fB\-v, \-\-version\fR
.IP
Show version of awesomeshot
.SH RUN OPTIONS
\fB\-a, \-\-auto\fR
.IP
Run awesomeshot with automatic while take screenshot
.TP
\fB\-m, \-\-manual\fR
.IP
Run awesomeshot with manual (this option require filename)
.TP
\fB\-c, \-\-config\fR
.IP
Generate default config \fI\,awesomeshot.conf\/\fR
.SH CONFIG OPTIONS
\fB\/screenshot_result_path\fR
.IP
Make sure when your phone screenshot the result file image\fR
PATH is same with this variable. Default my phone result file\fR
image PATH on
.IP
"/sdcard/DCIM/Screenshots"
.IP
If not same,\fR
you can edit this variable value\fR
.TP
\fB\/convert_to_png\fR
.IP
This variable serves to set the convert image with file type non PNG, change this value\fR
to blank or whatever for disable function and "yes" for enable function.\fR
Convert to PNG if file not PNG\fR
.TP
\fB\/backup\fR
.IP
This variable serves to function to backup original photo\fR
(screenshot result), change this value to blank or whatever for disable\fR
function and 'yes' for enable function\fR
.TP
\fB\/path_backup\fR
.IP
This variable serves to set the original photo backup PATH\fR
.TP
\fB\/hex_color\fR
.IP
Array Hex Color\fR
.TP
\fB\/convert_titlebar\fR
.IP
This variable serves to convert title bar when editing the image, change this value\fR
to blank or whatever for disable convert and 'yes' for enable function\fR
.TP
\fB\/add_on_img\fR
.IP
This variable serves to set where the title bar place, if 'yes' the title bar add on image,\fR
if blank or whatever the title bar will be added at out of image\fR
.TP
\fB\/width_img & height_img\fR
.IP
This variable serves to set the width and height size of title bar.\fR
.IP
NOTE (Bug Found):
.IP
- Sometimes the title bar result is too big or too small
.IP
width_img=$(magick file_name - format '%w' info:)
.IP
height_img=$(magick file_name - format '%h' info:)
.IP
if (( ${width_img} > ${height_img} )); then
.IP
height_img=${width_img}
.IP
elif (( ${width_img} < ${height_img} )); then
.IP
width_img=${height_img}
.IP
fi\fR
.TP
\fB\/titlebar_color\fR
.IP
This variable serves to set titlebar color, if you want to custom the color, you can
change this value with hex color or use the one in the array list.\fR
.TP
\fb\/convert_titlebar_text\fR
.IP
This variable serves to convert the titlebar text, change this value
to blank or whatever for disable function and "yes" for enable function.
.TP
\fb\/titlebar_text\fR
.IP
This variable serves to set titlebar text, if you want to use icon
you can search on Nerd Fonts Website (\fI\,https://www.nerdfonts.com/cheat-sheet\fR)
NOTE: if you use icon from Nerd Fonts, make sure "titlebar_text_font" using nerd fonts to!
.TP
\fb\/titlebar_text_position\fR
.IP
This variable serves to set text position of footer, the value contain 8 wind direction:
- NorthWest
.IP
- North
.IP
- West
.IP
- Center
.IP
- East
.IP
- SouthWest
.IP
- South
.IP
- SouthEast
.IP
NOTE: Default value is 'North'
.TP
\fB\/titlebar_text_size\fR
.IP
This variable serves to set font size
.TP
\fB\/titlebar_text_color\fR
.IP
This variable serves to set the text color, if you want to custom the color, you can
change this value with hex color or use the one in the array list.
.TP
\fB\/titlebar_text_background\fR
.IP
This variable serves to set titlebar text background color (background text), change this value
to "none" for transparent background, if you want to custom the color, you can
change this value with hex color or use the one in the array list.
.TP
\fB\/titlebar_text_font\fR
.IP
This variable serves to set the font used when converting, you can check the list font
available to use for ImageMagick by command:
.IP
magick convert -list font | grep -iE 'font:.*'
\fR
.TP
\fB\/titlebar_text_xy\fR
.IP
This variable serves to set position of "X" and "Y" titlebar text
.TP
\fB\/convert_rounded\fR
.IP
This variable serves to convert rounded corner, change this value
to blank or whatever for disable convert and 'yes' for enable function
\fR
.TP
\fB\/convert_radius\fR
.IP
This variable serves to set how many rounded corners
\fR
.TP
\fB\/convert_first_border\fR
.IP
This variable serves to convert tiny first border (background image) when editing the image,
change this value to blank or whatever for disable convert and 'yes' for enable function
\fR
.TP
\fB\/first_border_color\fR
.IP
This variable serves to set tiny first border color (background image), change this value
to 'none' for transparent background, if you want to custom the color, you can
change this value with hex color or use the one in the array list.
\fR
.TP
\fB\/first_border_size\fR
.IP
This variable serves to set how many size of the first border
NOTE: make sure this value is small, otherwise it will look weird
\fR
.TP
\fB\/convert_second_border\fR
.IP
This variable serves to convert border (background image) when editing the image,
change this value to blank or whatever for disable convert and 'yes' for enable function
\fR
.TP
\fB\/second_border_color\fR
.IP
This variable serves to set border color (background image), change this value
to 'none' for transparent background, if you want to custom the color, you can
change this value with hex color or use the one in the array list.
\fR
.TP
\fB\/second_border_size\fR
.IP
This variable serves to set how many size of the second border
\fR
.TP
\fB\/convert_shadow\fR
.IP
This variable serves to convert the shadow of image, change this value
to blank or whatever for disable function and 'yes' for enable function.
\fR
.TP
\fB\/shadow_color\fR
.IP
This variable serves to set shadow color, if you want to custom the color, you can
change this value with hex color or use the one in the array list.
\fR
.TP
\fb\/shadow_size\fR
.IP
This variable serves to set shadow size, this variable has four values:
shadow_size='75x30+0+30'
that mean:
.IP
- bottom shadow is x75
.IP
- right shadow is +30
.IP
- top shadow is +0
.IP
- left shadow is +30
\fR
.TP
\fb\/convert_footer\fR
.IP
This variable serves to convert the footer text, change this value
to blank or whatever for disable function and 'yes' for enable function.
\fR
.TP
\fb\/footer_text\fR
.IP
This variable serves to set text of footer, if you want to use icon
you can search on Nerd Fonts Website (\fI\,https://www.nerdfonts.com/cheat-sheet\fR)
NOTE: if you use icon from Nerd Fonts, make sure 'footer_font' using nerd fonts to!
\fR
.TP
\fb\/footer_position\fR
.IP
This variable serves to set text position of footer, the value contain 8 wind direction:
- NorthWest
.IP
- North
.IP
- West
.IP
- Center
.IP
- East
.IP
- SouthWest
.IP
- South
.IP
- SouthEast
.IP
NOTE: Default value is 'South'
\fR
.TP
\fb\/footer_xy\fR
.IP
This variable serves to set position of 'X' and 'Y'
\fR
.TP
\fb\/footer_font\fR
.IP
This variable serves to set the font used when converting, you can check the list font
available to use for ImageMagick by command:
.IP
magick convert -list font | grep -iE 'font:.*'
\fR
.TP
\fb\/footer_font_size\fR
.IP
This variable serves to set font size
\fR
.TP
\fb\/footer_foreground\fR
.IP
This variable serves to set the text color, if you want to custom the color, you can
change this value with hex color or use the one in the array list.
\fR
.TP
\fb\/footer_background\fR
.IP
This variable serves to set footer background color (background text), change this value
to 'none' for transparent background, if you want to custom the color, you can
change this value with hex color or use the one in the array list.
\fR
.TP
\fb\/open_image\fR
.IP
This variable serves to open the result of image (when editing finished), change this value
to blank or whatever for disable function and 'yes' for enable function.
\fR