@@ -6,33 +6,33 @@ Core functions for any Bash program
66
77## Index
88
9- * [ core.trap_add() ] ( #coretrap_add )
10- * [ core.trap_remove() ] ( #coretrap_remove )
11- * [ core.shopt_push() ] ( #coreshopt_push )
12- * [ core.shopt_pop() ] ( #coreshopt_pop )
13- * [ core.err_set() ] ( #coreerr_set )
14- * [ core.err_clear() ] ( #coreerr_clear )
15- * [ core.err_exists() ] ( #coreerr_exists )
16- * [ core.panic() ] ( #corepanic )
17- * [ core.print_stacktrace() ] ( #coreprint_stacktrace )
18- * [ core.print_fatal_fn() ] ( #coreprint_fatal_fn )
19- * [ core.print_error_fn() ] ( #coreprint_error_fn )
20- * [ core.print_warn_fn() ] ( #coreprint_warn_fn )
21- * [ core.print_info_fn() ] ( #coreprint_info_fn )
22- * [ core.print_debug_fn() ] ( #coreprint_debug_fn )
23- * [ core.print_fatal() ] ( #coreprint_fatal )
24- * [ core.print_error() ] ( #coreprint_error )
25- * [ core.print_warn() ] ( #coreprint_warn )
26- * [ core.print_info() ] ( #coreprint_info )
27- * [ core.print_debug() ] ( #coreprint_debug )
28- * [ core.should_output_color() ] ( #coreshould_output_color )
29- * [ core.get_package_info() ] ( #coreget_package_info )
30- * [ core.init() ] ( #coreinit )
31- * [ core.stacktrace_print() ] ( #corestacktrace_print )
32- * [ core.print_die_fn() ] ( #coreprint_die_fn )
33- * [ core.print_die() ] ( #coreprint_die )
34-
35- ### core.trap_add()
9+ * [ core.trap_add] ( #coretrap_add )
10+ * [ core.trap_remove] ( #coretrap_remove )
11+ * [ core.shopt_push] ( #coreshopt_push )
12+ * [ core.shopt_pop] ( #coreshopt_pop )
13+ * [ core.err_set] ( #coreerr_set )
14+ * [ core.err_clear] ( #coreerr_clear )
15+ * [ core.err_exists] ( #coreerr_exists )
16+ * [ core.panic] ( #corepanic )
17+ * [ core.print_stacktrace] ( #coreprint_stacktrace )
18+ * [ core.print_fatal_fn] ( #coreprint_fatal_fn )
19+ * [ core.print_error_fn] ( #coreprint_error_fn )
20+ * [ core.print_warn_fn] ( #coreprint_warn_fn )
21+ * [ core.print_info_fn] ( #coreprint_info_fn )
22+ * [ core.print_debug_fn] ( #coreprint_debug_fn )
23+ * [ core.print_fatal] ( #coreprint_fatal )
24+ * [ core.print_error] ( #coreprint_error )
25+ * [ core.print_warn] ( #coreprint_warn )
26+ * [ core.print_info] ( #coreprint_info )
27+ * [ core.print_debug] ( #coreprint_debug )
28+ * [ core.should_output_color] ( #coreshould_output_color )
29+ * [ core.get_package_info] ( #coreget_package_info )
30+ * [ core.init] ( #coreinit )
31+ * [ core.stacktrace_print] ( #corestacktrace_print )
32+ * [ core.print_die_fn] ( #coreprint_die_fn )
33+ * [ core.print_die] ( #coreprint_die )
34+
35+ ### core.trap_add
3636
3737Adds a handler for a particular ` trap ` signal or event. Noticably,
3838unlike the 'builtin' trap, this does not override any other existing handlers. The first argument
@@ -52,7 +52,7 @@ core.trap_remove 'some_handler' 'USR1'
5252* ** $1** (string): Function to execute on an event. Integers are forbiden
5353* ** $2** (string): Event signal
5454
55- ### core.trap_remove()
55+ ### core.trap_remove
5656
5757Removes a handler for a particular ` trap ` signal or event. Currently,
5858if the function doest not exist, it prints an error
@@ -71,7 +71,7 @@ core.trap_remove 'some_handler' 'USR1'
7171* ** $1** (string): Function to remove
7272* ** $2** (string): Signal that the function executed on
7373
74- ### core.shopt_push()
74+ ### core.shopt_push
7575
7676Modifies current shell options and pushes information to stack, so
7777it can later be easily undone. Note that it does not check to see if your Bash
@@ -90,7 +90,7 @@ core.shopt_pop
9090* ** $1** (string): Name of shopt action. Can either be ` -u ` or ` -s `
9191* ** $2** (string): Name of shopt name
9292
93- ### core.shopt_pop()
93+ ### core.shopt_pop
9494
9595Modifies current shell options based on most recent item added to stack.
9696
@@ -104,7 +104,7 @@ core.shopt_pop
104104
105105_ Function has no arguments._
106106
107- ### core.err_set()
107+ ### core.err_set
108108
109109Sets an error.
110110
@@ -118,7 +118,7 @@ Sets an error.
118118* ** number** (ERRCODE): Error code
119119* ** string** (ERR): Error message
120120
121- ### core.err_clear()
121+ ### core.err_clear
122122
123123Clears any of the global error state (sets to empty string).
124124This means any ` core.err_exists ` calls after this _ will_ ` return 1 `
@@ -130,18 +130,18 @@ _Function has no arguments._
130130* ** number** (ERRCODE): Error code
131131* ** string** (ERR): Error message
132132
133- ### core.err_exists()
133+ ### core.err_exists
134134
135135Checks if an error exists. If ` ERR ` is not empty, then an error
136136_ does_ exist
137137
138138_ Function has no arguments._
139139
140- ### core.panic()
140+ ### core.panic
141141
142142Use when a serious fault occurs. It will print the current ERR (if it exists)
143143
144- ### core.print_stacktrace()
144+ ### core.print_stacktrace
145145
146146Prints stacktrace
147147
@@ -160,7 +160,7 @@ core.trap_add 'err_handler' ERR
160160
161161_ Function has no arguments._
162162
163- ### core.print_fatal_fn()
163+ ### core.print_fatal_fn
164164
165165Print a fatal error message including the function name of the callee
166166to standard error
@@ -169,7 +169,7 @@ to standard error
169169
170170* ** $1** (string): message
171171
172- ### core.print_error_fn()
172+ ### core.print_error_fn
173173
174174Print an error message including the function name of the callee
175175to standard error
@@ -178,7 +178,7 @@ to standard error
178178
179179* ** $1** (string): message
180180
181- ### core.print_warn_fn()
181+ ### core.print_warn_fn
182182
183183Print a warning message including the function name of the callee
184184to standard error
@@ -187,7 +187,7 @@ to standard error
187187
188188* ** $1** (string): message
189189
190- ### core.print_info_fn()
190+ ### core.print_info_fn
191191
192192Print an informative message including the function name of the callee
193193to standard output
@@ -196,7 +196,7 @@ to standard output
196196
197197* ** $1** (string): message
198198
199- ### core.print_debug_fn()
199+ ### core.print_debug_fn
200200
201201Print a debug message including the function name of the callee
202202to standard output
@@ -205,53 +205,53 @@ to standard output
205205
206206* ** $1** (string): message
207207
208- ### core.print_fatal()
208+ ### core.print_fatal
209209
210210Print a fatal error message to standard error
211211
212212#### Arguments
213213
214214* ** $1** (string): message
215215
216- ### core.print_error()
216+ ### core.print_error
217217
218218Print an error message to standard error
219219
220220#### Arguments
221221
222222* ** $1** (string): message
223223
224- ### core.print_warn()
224+ ### core.print_warn
225225
226226Print a warning message to standard error
227227
228228#### Arguments
229229
230230* ** $1** (string): message
231231
232- ### core.print_info()
232+ ### core.print_info
233233
234234Print an informative message to standard output
235235
236236#### Arguments
237237
238238* ** $1** (string): message
239239
240- ### core.print_debug()
240+ ### core.print_debug
241241
242242Print a debug message to standard output if the environment variable "DEBUG" is present
243243
244244#### Arguments
245245
246246* ** $1** (string): message
247247
248- ### core.should_output_color()
248+ ### core.should_output_color
249249
250250(DEPRECATED). Determine if color should be printed. Note that this doesn't
251251use tput because simple environment variable checking heuristics suffice. Deprecated because this code
252252has been moved to bash-std
253253
254- ### core.get_package_info()
254+ ### core.get_package_info
255255
256256(DEPRECATED) Gets information from a particular package. If the key does not exist, then the value
257257is an empty string. Deprecated as this code has been moved to bash-std
@@ -264,22 +264,22 @@ is an empty string. Deprecated as this code has been moved to bash-std
264264
265265* ** directory** (string): The full path to the directory
266266
267- ### core.init()
267+ ### core.init
268268
269269(DEPRECATED) Initiates global variables used by other functions. Deprecated as
270270this function is called automatically by functions that use global variables
271271
272272_ Function has no arguments._
273273
274- ### core.stacktrace_print()
274+ ### core.stacktrace_print
275275
276276(DEPRECATED) Prints stacktrace
277277
278278#### See also
279279
280280* [ core.print_stacktrace] ( #coreprint_stacktrace )
281281
282- ### core.print_die_fn()
282+ ### core.print_die_fn
283283
284284(DEPRECATED) Print a error message to standard error including the function name
285285of the callee to standard error and die
@@ -288,7 +288,7 @@ of the callee to standard error and die
288288
289289* ** $1** (string): message
290290
291- ### core.print_die()
291+ ### core.print_die
292292
293293(DEPRECATED) Print a error message to standard error and die
294294
0 commit comments