3 SPDX-License-Identifier: BSD-2-Clause
5 Copyright (c) 2018-2020 Gavin D. Howard and contributors.
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
10 * Redistributions of source code must retain the above copyright notice, this
11 list of conditions and the following disclaimer.
13 * Redistributions in binary form must reproduce the above copyright notice,
14 this list of conditions and the following disclaimer in the documentation
15 and/or other materials provided with the distribution.
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
21 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 POSSIBILITY OF SUCH DAMAGE.
33 dc - arbitrary-precision decimal reverse-Polish notation calculator
37 **dc** [**-hiPvVx**] [**--version**] [**--help**] [**--interactive**] [**--no-prompt**] [**--extended-register**] [**-e** *expr*] [**--expression**=*expr*...] [**-f** *file*...] [**-file**=*file*...] [*file*...]
41 dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish
42 notation) to store numbers and results of computations. Arithmetic operations
43 pop arguments off of the stack and push the results.
45 If no files are given on the command-line as extra arguments (i.e., not as
46 **-f** or **--file** arguments), then dc(1) reads from **stdin**. Otherwise,
47 those files are processed, and dc(1) will then exit.
49 This is different from the dc(1) on OpenBSD and possibly other dc(1)
50 implementations, where **-e** (**--expression**) and **-f** (**--file**)
51 arguments cause dc(1) to execute them and exit. The reason for this is that this
52 dc(1) allows users to set arguments in the environment variable **DC_ENV_ARGS**
53 (see the **ENVIRONMENT VARIABLES** section). Any expressions given on the
54 command-line should be used to set up a standard environment. For example, if a
55 user wants the **scale** always set to **10**, they can set **DC_ENV_ARGS** to
56 **-e 10k**, and this dc(1) will always start with a **scale** of **10**.
58 If users want to have dc(1) exit after processing all input from **-e** and
59 **-f** arguments (and their equivalents), then they can just simply add **-e q**
60 as the last command-line argument or define the environment variable
65 The following are the options that dc(1) accepts.
69 : Prints a usage message and quits.
71 **-v**, **-V**, **--version**
73 : Print the version information (copyright header) and exit.
75 **-i**, **--interactive**
77 : Forces interactive mode. (See the **INTERACTIVE MODE** section.)
79 This is a **non-portable extension**.
81 **-P**, **--no-prompt**
83 : Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode.
84 See the **TTY MODE** section) This is mostly for those users that do not
85 want a prompt or are not used to having them in dc(1). Most of those users
86 would want to put this option in **DC_ENV_ARGS**.
88 This is a **non-portable extension**.
90 **-x** **--extended-register**
92 : Enables extended register mode. See the *Extended Register Mode* subsection
93 of the **REGISTERS** section for more information.
95 This is a **non-portable extension**.
97 **-e** *expr*, **--expression**=*expr*
99 : Evaluates *expr*. If multiple expressions are given, they are evaluated in
100 order. If files are given as well (see below), the expressions and files are
101 evaluated in the order given. This means that if a file is given before an
102 expression, the file is read in and evaluated first.
104 After processing all expressions and files, dc(1) will exit, unless **-**
105 (**stdin**) was given as an argument at least once to **-f** or **--file**.
107 This is a **non-portable extension**.
109 **-f** *file*, **--file**=*file*
111 : Reads in *file* and evaluates it, line by line, as though it were read
112 through **stdin**. If expressions are also given (see above), the
113 expressions are evaluated in the order given.
115 After processing all expressions and files, dc(1) will exit, unless **-**
116 (**stdin**) was given as an argument at least once to **-f** or **--file**.
117 However, if any other **-e**, **--expression**, **-f**, or **--file**
118 arguments are given after that, bc(1) will give a fatal error and exit.
120 This is a **non-portable extension**.
122 All long options are **non-portable extensions**.
126 Any non-error output is written to **stdout**.
128 **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal
129 error (see the **EXIT STATUS** section) if it cannot write to **stdout**, so if
130 **stdout** is closed, as in **dc <file> >&-**, it will quit with an error. This
131 is done so that dc(1) can report problems when **stdout** is redirected to a
134 If there are scripts that depend on the behavior of other dc(1) implementations,
135 it is recommended that those scripts be changed to redirect **stdout** to
140 Any error output is written to **stderr**.
142 **Note**: Unlike other dc(1) implementations, this dc(1) will issue a fatal
143 error (see the **EXIT STATUS** section) if it cannot write to **stderr**, so if
144 **stderr** is closed, as in **dc <file> 2>&-**, it will quit with an error. This
145 is done so that dc(1) can exit with an error code when **stderr** is redirected
148 If there are scripts that depend on the behavior of other dc(1) implementations,
149 it is recommended that those scripts be changed to redirect **stderr** to
154 Each item in the input source code, either a number (see the **NUMBERS**
155 section) or a command (see the **COMMANDS** section), is processed and executed,
156 in order. Input is processed immediately when entered.
158 **ibase** is a register (see the **REGISTERS** section) that determines how to
159 interpret constant numbers. It is the "input" base, or the number base used for
160 interpreting input numbers. **ibase** is initially **10**. The max allowable
161 value for **ibase** is **16**. The min allowable value for **ibase** is **2**.
162 The max allowable value for **ibase** can be queried in dc(1) programs with the
165 **obase** is a register (see the **REGISTERS** section) that determines how to
166 output results. It is the "output" base, or the number base used for outputting
167 numbers. **obase** is initially **10**. The max allowable value for **obase** is
168 **DC_BASE_MAX** and can be queried with the **U** command. The min allowable
169 value for **obase** is **2**. Values are output in the specified base.
171 The *scale* of an expression is the number of digits in the result of the
172 expression right of the decimal point, and **scale** is a register (see the
173 **REGISTERS** section) that sets the precision of any operations (with
174 exceptions). **scale** is initially **0**. **scale** cannot be negative. The max
175 allowable value for **scale** can be queried in dc(1) programs with the **V**
180 Comments go from **#** until, and not including, the next newline. This is a
181 **non-portable extension**.
185 Numbers are strings made up of digits, uppercase letters up to **F**, and at
186 most **1** period for a radix. Numbers can have up to **DC_NUM_MAX** digits.
187 Uppercase letters are equal to **9** + their position in the alphabet (i.e.,
188 **A** equals **10**, or **9+1**). If a digit or letter makes no sense with the
189 current value of **ibase**, they are set to the value of the highest valid digit
192 Single-character numbers (i.e., **A** alone) take the value that they would have
193 if they were valid digits, regardless of the value of **ibase**. This means that
194 **A** alone always equals decimal **10** and **F** alone always equals decimal
199 The valid commands are listed below.
203 These commands are used for printing.
207 : Prints the value on top of the stack, whether number or string, and prints a
210 This does not alter the stack.
214 : Prints the value on top of the stack, whether number or string, and pops it
219 : Pops a value off the stack.
221 If the value is a number, it is truncated and the absolute value of the
222 result is printed as though **obase** is **UCHAR_MAX+1** and each digit is
223 interpreted as an ASCII character, making it a byte stream.
225 If the value is a string, it is printed without a trailing newline.
227 This is a **non-portable extension**.
231 : Prints the entire contents of the stack, in order from newest to oldest,
232 without altering anything.
234 Users should use this command when they get lost.
238 These are the commands used for arithmetic.
242 : The top two values are popped off the stack, added, and the result is pushed
243 onto the stack. The *scale* of the result is equal to the max *scale* of
248 : The top two values are popped off the stack, subtracted, and the result is
249 pushed onto the stack. The *scale* of the result is equal to the max
250 *scale* of both operands.
254 : The top two values are popped off the stack, multiplied, and the result is
255 pushed onto the stack. If **a** is the *scale* of the first expression and
256 **b** is the *scale* of the second expression, the *scale* of the result
257 is equal to **min(a+b,max(scale,a,b))** where **min()** and **max()** return
262 : The top two values are popped off the stack, divided, and the result is
263 pushed onto the stack. The *scale* of the result is equal to **scale**.
265 The first value popped off of the stack must be non-zero.
269 : The top two values are popped off the stack, remaindered, and the result is
270 pushed onto the stack.
272 Remaindering is equivalent to 1) Computing **a/b** to current **scale**, and
273 2) Using the result of step 1 to calculate **a-(a/b)\*b** to *scale*
274 **max(scale+scale(b),scale(a))**.
276 The first value popped off of the stack must be non-zero.
280 : The top two values are popped off the stack, divided and remaindered, and
281 the results (divided first, remainder second) are pushed onto the stack.
282 This is equivalent to **x y / x y %** except that **x** and **y** are only
285 The first value popped off of the stack must be non-zero.
287 This is a **non-portable extension**.
291 : The top two values are popped off the stack, the second is raised to the
292 power of the first, and the result is pushed onto the stack. The *scale* of
293 the result is equal to **scale**.
295 The first value popped off of the stack must be an integer, and if that
296 value is negative, the second value popped off of the stack must be
301 : The top value is popped off the stack, its square root is computed, and the
302 result is pushed onto the stack. The *scale* of the result is equal to
305 The value popped off of the stack must be non-negative.
309 : If this command *immediately* precedes a number (i.e., no spaces or other
310 commands), then that number is input as a negative number.
312 Otherwise, the top value on the stack is popped and copied, and the copy is
313 negated and pushed onto the stack. This behavior without a number is a
314 **non-portable extension**.
318 : The top value is popped off the stack, and if it is zero, it is pushed back
319 onto the stack. Otherwise, its absolute value is pushed onto the stack.
321 This is a **non-portable extension**.
325 : The top three values are popped off the stack, a modular exponentiation is
326 computed, and the result is pushed onto the stack.
328 The first value popped is used as the reduction modulus and must be an
329 integer and non-zero. The second value popped is used as the exponent and
330 must be an integer and non-negative. The third value popped is the base and
333 This is a **non-portable extension**.
337 : The top two values are popped off of the stack, they are compared, and a
338 **1** is pushed if they are equal, or **0** otherwise.
340 This is a **non-portable extension**.
344 : The top value is popped off of the stack, and if it a **0**, a **1** is
345 pushed; otherwise, a **0** is pushed.
347 This is a **non-portable extension**.
351 : The top two values are popped off of the stack, they are compared, and a
352 **1** is pushed if the first is less than the second, or **0** otherwise.
354 This is a **non-portable extension**.
358 : The top two values are popped off of the stack, they are compared, and a
359 **1** is pushed if the first is less than or equal to the second, or **0**
362 This is a **non-portable extension**.
366 : The top two values are popped off of the stack, they are compared, and a
367 **1** is pushed if the first is greater than the second, or **0** otherwise.
369 This is a **non-portable extension**.
373 : The top two values are popped off of the stack, they are compared, and a
374 **1** is pushed if the first is greater than or equal to the second, or
377 This is a **non-portable extension**.
381 : The top two values are popped off of the stack. If they are both non-zero, a
382 **1** is pushed onto the stack. If either of them is zero, or both of them
383 are, then a **0** is pushed onto the stack.
385 This is like the **&&** operator in bc(1), and it is *not* a short-circuit
388 This is a **non-portable extension**.
392 : The top two values are popped off of the stack. If at least one of them is
393 non-zero, a **1** is pushed onto the stack. If both of them are zero, then a
394 **0** is pushed onto the stack.
396 This is like the **||** operator in bc(1), and it is *not* a short-circuit
399 This is a **non-portable extension**.
403 These commands control the stack.
407 : Removes all items from ("clears") the stack.
411 : Copies the item on top of the stack ("duplicates") and pushes the copy onto
416 : Swaps ("reverses") the two top items on the stack.
420 : Pops ("removes") the top value from the stack.
424 These commands control registers (see the **REGISTERS** section).
428 : Pops the value off the top of the stack and stores it into register *r*.
432 : Copies the value in register *r* and pushes it onto the stack. This does not
433 alter the contents of *r*.
437 : Pops the value off the top of the (main) stack and pushes it onto the stack
438 of register *r*. The previous value of the register becomes inaccessible.
442 : Pops the value off the top of the stack for register *r* and push it onto
443 the main stack. The previous value in the stack for register *r*, if any, is
444 now accessible via the **l***r* command.
448 These commands control the values of **ibase**, **obase**, and **scale**. Also
449 see the **SYNTAX** section.
453 : Pops the value off of the top of the stack and uses it to set **ibase**,
454 which must be between **2** and **16**, inclusive.
456 If the value on top of the stack has any *scale*, the *scale* is ignored.
460 : Pops the value off of the top of the stack and uses it to set **obase**,
461 which must be between **2** and **DC_BASE_MAX**, inclusive (see the
464 If the value on top of the stack has any *scale*, the *scale* is ignored.
468 : Pops the value off of the top of the stack and uses it to set **scale**,
469 which must be non-negative.
471 If the value on top of the stack has any *scale*, the *scale* is ignored.
475 : Pushes the current value of **ibase** onto the main stack.
479 : Pushes the current value of **obase** onto the main stack.
483 : Pushes the current value of **scale** onto the main stack.
487 : Pushes the maximum allowable value of **ibase** onto the main stack.
489 This is a **non-portable extension**.
493 : Pushes the maximum allowable value of **obase** onto the main stack.
495 This is a **non-portable extension**.
499 : Pushes the maximum allowable value of **scale** onto the main stack.
501 This is a **non-portable extension**.
505 The following commands control strings.
507 dc(1) can work with both numbers and strings, and registers (see the
508 **REGISTERS** section) can hold both strings and numbers. dc(1) always knows
509 whether the contents of a register are a string or a number.
511 While arithmetic operations have to have numbers, and will print an error if
512 given a string, other commands accept strings.
514 Strings can also be executed as macros. For example, if the string **[1pR]** is
515 executed as a macro, then the code **1pR** is executed, meaning that the **1**
516 will be printed with a newline after and then popped from the stack.
518 **\[**_characters_**\]**
520 : Makes a string containing *characters* and pushes it onto the stack.
522 If there are brackets (**\[** and **\]**) in the string, then they must be
523 balanced. Unbalanced brackets can be escaped using a backslash (**\\**)
526 If there is a backslash character in the string, the character after it
527 (even another backslash) is put into the string verbatim, but the (first)
532 : The value on top of the stack is popped.
534 If it is a number, it is truncated and its absolute value is taken. The
535 result mod **UCHAR_MAX+1** is calculated. If that result is **0**, push an
536 empty string; otherwise, push a one-character string where the character is
537 the result of the mod interpreted as an ASCII character.
539 If it is a string, then a new string is made. If the original string is
540 empty, the new string is empty. If it is not, then the first character of
541 the original string is used to create the new string as a one-character
542 string. The new string is then pushed onto the stack.
544 This is a **non-portable extension**.
548 : Pops a value off of the top of the stack.
550 If it is a number, it is pushed back onto the stack.
552 If it is a string, it is executed as a macro.
554 This behavior is the norm whenever a macro is executed, whether by this
555 command or by the conditional execution commands below.
559 : Pops two values off of the stack that must be numbers and compares them. If
560 the first value is greater than the second, then the contents of register
563 For example, **0 1>a** will execute the contents of register **a**, and
566 If either or both of the values are not numbers, dc(1) will raise an error
567 and reset (see the **RESET** section).
571 : Like the above, but will execute register *s* if the comparison fails.
573 If either or both of the values are not numbers, dc(1) will raise an error
574 and reset (see the **RESET** section).
576 This is a **non-portable extension**.
580 : Pops two values off of the stack that must be numbers and compares them. If
581 the first value is not greater than the second (less than or equal to), then
582 the contents of register *r* are executed.
584 If either or both of the values are not numbers, dc(1) will raise an error
585 and reset (see the **RESET** section).
589 : Like the above, but will execute register *s* if the comparison fails.
591 If either or both of the values are not numbers, dc(1) will raise an error
592 and reset (see the **RESET** section).
594 This is a **non-portable extension**.
598 : Pops two values off of the stack that must be numbers and compares them. If
599 the first value is less than the second, then the contents of register *r*
602 If either or both of the values are not numbers, dc(1) will raise an error
603 and reset (see the **RESET** section).
607 : Like the above, but will execute register *s* if the comparison fails.
609 If either or both of the values are not numbers, dc(1) will raise an error
610 and reset (see the **RESET** section).
612 This is a **non-portable extension**.
616 : Pops two values off of the stack that must be numbers and compares them. If
617 the first value is not less than the second (greater than or equal to), then
618 the contents of register *r* are executed.
620 If either or both of the values are not numbers, dc(1) will raise an error
621 and reset (see the **RESET** section).
625 : Like the above, but will execute register *s* if the comparison fails.
627 If either or both of the values are not numbers, dc(1) will raise an error
628 and reset (see the **RESET** section).
630 This is a **non-portable extension**.
634 : Pops two values off of the stack that must be numbers and compares them. If
635 the first value is equal to the second, then the contents of register *r*
638 If either or both of the values are not numbers, dc(1) will raise an error
639 and reset (see the **RESET** section).
643 : Like the above, but will execute register *s* if the comparison fails.
645 If either or both of the values are not numbers, dc(1) will raise an error
646 and reset (see the **RESET** section).
648 This is a **non-portable extension**.
652 : Pops two values off of the stack that must be numbers and compares them. If
653 the first value is not equal to the second, then the contents of register
656 If either or both of the values are not numbers, dc(1) will raise an error
657 and reset (see the **RESET** section).
661 : Like the above, but will execute register *s* if the comparison fails.
663 If either or both of the values are not numbers, dc(1) will raise an error
664 and reset (see the **RESET** section).
666 This is a **non-portable extension**.
670 : Reads a line from the **stdin** and executes it. This is to allow macros to
671 request input from users.
675 : During execution of a macro, this exits the execution of that macro and the
676 execution of the macro that executed it. If there are no macros, or only one
677 macro executing, dc(1) exits.
681 : Pops a value from the stack which must be non-negative and is used the
682 number of macro executions to pop off of the execution stack. If the number
683 of levels to pop is greater than the number of executing macros, dc(1)
688 These commands query status of the stack or its top value.
692 : Pops a value off of the stack.
694 If it is a number, calculates the number of significant decimal digits it
695 has and pushes the result.
697 If it is a string, pushes the number of characters the string has.
701 : Pops a value off of the stack.
703 If it is a number, pushes the *scale* of the value onto the stack.
705 If it is a string, pushes **0**.
709 : Pushes the current stack depth (before execution of this command).
713 These commands manipulate arrays.
717 : Pops the top two values off of the stack. The second value will be stored in
718 the array *r* (see the **REGISTERS** section), indexed by the first value.
722 : Pops the value on top of the stack and uses it as an index into the array
723 *r*. The selected value is then pushed onto the stack.
727 Registers are names that can store strings, numbers, and arrays. (Number/string
728 registers do not interfere with array registers.)
730 Each register is also its own stack, so the current register value is the top of
731 the stack for the register. All registers, when first referenced, have one value
732 (**0**) in their stack.
734 In non-extended register mode, a register name is just the single character that
735 follows any command that needs a register name. The only exception is a newline
736 (**'\\n'**); it is a parse error for a newline to be used as a register name.
738 ## Extended Register Mode
740 Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited
741 amounts of registers, if extended register mode is enabled.
743 If extended register mode is enabled (**-x** or **--extended-register**
744 command-line arguments are given), then normal single character registers are
745 used *unless* the character immediately following a command that needs a
746 register name is a space (according to **isspace()**) and not a newline
749 In that case, the register name is found according to the regex
750 **\[a-z\]\[a-z0-9\_\]\*** (like bc(1) identifiers), and it is a parse error if
751 the next non-space characters do not match that regex.
755 When dc(1) encounters an error or a signal that it has a non-default handler
756 for, it resets. This means that several things happen.
758 First, any macros that are executing are stopped and popped off the stack.
759 The behavior is not unlike that of exceptions in programming languages. Then
760 the execution point is set so that any code waiting to execute (after all
761 macros returned) is skipped.
763 Thus, when dc(1) resets, it skips any remaining code waiting to be executed.
764 Then, if it is interactive mode, and the error was not a fatal error (see the
765 **EXIT STATUS** section), it asks for more input; otherwise, it exits with the
766 appropriate return code.
770 Most dc(1) implementations use **char** types to calculate the value of **1**
771 decimal digit at a time, but that can be slow. This dc(1) does something
774 It uses large integers to calculate more than **1** decimal digit at a time. If
775 built in a environment where **DC_LONG_BIT** (see the **LIMITS** section) is
776 **64**, then each integer has **9** decimal digits. If built in an environment
777 where **DC_LONG_BIT** is **32** then each integer has **4** decimal digits. This
778 value (the number of decimal digits per large integer) is called
781 In addition, this dc(1) uses an even larger integer for overflow checking. This
782 integer type depends on the value of **DC_LONG_BIT**, but is always at least
783 twice as large as the integer type used to store digits.
787 The following are the limits on dc(1):
791 : The number of bits in the **long** type in the environment where dc(1) was
792 built. This determines how many decimal digits can be stored in a single
793 large integer (see the **PERFORMANCE** section).
797 : The number of decimal digits per large integer (see the **PERFORMANCE**
798 section). Depends on **DC_LONG_BIT**.
802 : The max decimal number that each large integer can store (see
803 **DC_BASE_DIGS**) plus **1**. Depends on **DC_BASE_DIGS**.
807 : The max number that the overflow type (see the **PERFORMANCE** section) can
808 hold. Depends on **DC_LONG_BIT**.
812 : The maximum output base. Set at **DC_BASE_POW**.
816 : The maximum size of arrays. Set at **SIZE_MAX-1**.
820 : The maximum **scale**. Set at **DC_OVERFLOW_MAX-1**.
824 : The maximum length of strings. Set at **DC_OVERFLOW_MAX-1**.
828 : The maximum length of identifiers. Set at **DC_OVERFLOW_MAX-1**.
832 : The maximum length of a number (in decimal digits), which includes digits
833 after the decimal point. Set at **DC_OVERFLOW_MAX-1**.
837 : The maximum allowable exponent (positive or negative). Set at
842 : The maximum number of vars/arrays. Set at **SIZE_MAX-1**.
844 These limits are meant to be effectively non-existent; the limits are so large
845 (at least on 64-bit machines) that there should not be any point at which they
846 become a problem. In fact, memory should be exhausted before these limits should
849 # ENVIRONMENT VARIABLES
851 dc(1) recognizes the following environment variables:
855 : This is another way to give command-line arguments to dc(1). They should be
856 in the same format as all other command-line arguments. These are always
857 processed first, so any files given in **DC_ENV_ARGS** will be processed
858 before arguments and files given on the command-line. This gives the user
859 the ability to set up "standard" options and files to be used at every
860 invocation. The most useful thing for such files to contain would be useful
861 functions that the user might want every time dc(1) runs. Another use would
862 be to use the **-e** option to set **scale** to a value other than **0**.
864 The code that parses **DC_ENV_ARGS** will correctly handle quoted arguments,
865 but it does not understand escape sequences. For example, the string
866 **"/home/gavin/some dc file.dc"** will be correctly parsed, but the string
867 **"/home/gavin/some \"dc\" file.dc"** will include the backslashes.
869 The quote parsing will handle either kind of quotes, **'** or **"**. Thus,
870 if you have a file with any number of single quotes in the name, you can use
871 double quotes as the outside quotes, as in **"some 'bc' file.bc"**, and vice
872 versa if you have a file with double quotes. However, handling a file with
873 both kinds of quotes in **DC_ENV_ARGS** is not supported due to the
874 complexity of the parsing, though such files are still supported on the
875 command-line where the parsing is done by the shell.
879 : If this environment variable exists and contains an integer that is greater
880 than **1** and is less than **UINT16_MAX** (**2\^16-1**), dc(1) will output
881 lines to that length, including the backslash newline combo. The default
882 line length is **70**.
886 : If this variable exists (no matter the contents), dc(1) will exit
887 immediately after executing expressions and files given by the **-e** and/or
888 **-f** command-line options (and any equivalents).
892 dc(1) returns the following exit statuses:
900 : A math error occurred. This follows standard practice of using **1** for
901 expected errors, since math errors will happen in the process of normal
904 Math errors include divide by **0**, taking the square root of a negative
905 number, attempting to convert a negative number to a hardware integer,
906 overflow when converting a number to a hardware integer, and attempting to
907 use a non-integer where an integer is required.
909 Converting to a hardware integer happens for the second operand of the power
914 : A parse error occurred.
916 Parse errors include unexpected **EOF**, using an invalid character, failing
917 to find the end of a string or comment, and using a token where it is
922 : A runtime error occurred.
924 Runtime errors include assigning an invalid number to **ibase**, **obase**,
925 or **scale**; give a bad expression to a **read()** call, calling **read()**
926 inside of a **read()** call, type errors, and attempting an operation when
927 the stack has too few elements.
931 : A fatal error occurred.
933 Fatal errors include memory allocation errors, I/O errors, failing to open
934 files, attempting to use files that do not have only ASCII characters (dc(1)
935 only accepts ASCII characters), attempting to open a directory as a file,
936 and giving invalid command-line options.
938 The exit status **4** is special; when a fatal error occurs, dc(1) always exits
939 and returns **4**, no matter what mode dc(1) is in.
941 The other statuses will only be returned when dc(1) is not in interactive mode
942 (see the **INTERACTIVE MODE** section), since dc(1) resets its state (see the
943 **RESET** section) and accepts more input when one of those errors occurs in
944 interactive mode. This is also the case when interactive mode is forced by the
945 **-i** flag or **--interactive** option.
947 These exit statuses allow dc(1) to be used in shell scripting with error
948 checking, and its normal behavior can be forced by using the **-i** flag or
949 **--interactive** option.
953 Like bc(1), dc(1) has an interactive mode and a non-interactive mode.
954 Interactive mode is turned on automatically when both **stdin** and **stdout**
955 are hooked to a terminal, but the **-i** flag and **--interactive** option can
956 turn it on in other cases.
958 In interactive mode, dc(1) attempts to recover from errors (see the **RESET**
959 section), and in normal execution, flushes **stdout** as soon as execution is
960 done for the current input.
964 If **stdin**, **stdout**, and **stderr** are all connected to a TTY, dc(1) turns
967 TTY mode is required for history to be enabled (see the **COMMAND LINE HISTORY**
968 section). It is also required to enable special handling for **SIGINT** signals.
970 The prompt is enabled in TTY mode.
972 TTY mode is different from interactive mode because interactive mode is required
973 in the [bc(1) specification][1], and interactive mode requires only **stdin**
974 and **stdout** to be connected to a terminal.
978 Sending a **SIGINT** will cause dc(1) to stop execution of the current input. If
979 dc(1) is in TTY mode (see the **TTY MODE** section), it will reset (see the
980 **RESET** section). Otherwise, it will clean up and exit.
982 Note that "current input" can mean one of two things. If dc(1) is processing
983 input from **stdin** in TTY mode, it will ask for more input. If dc(1) is
984 processing input from a file in TTY mode, it will stop processing the file and
985 start processing the next file, if one exists, or ask for input from **stdin**
986 if no other file exists.
988 This means that if a **SIGINT** is sent to dc(1) as it is executing a file, it
989 can seem as though dc(1) did not respond to the signal since it will immediately
990 start executing the next file. This is by design; most files that users execute
991 when interacting with dc(1) have function definitions, which are quick to parse.
992 If a file takes a long time to execute, there may be a bug in that file. The
993 rest of the files could still be executed without problem, allowing the user to
996 **SIGTERM** and **SIGQUIT** cause dc(1) to clean up and exit, and it uses the
997 default handler for all other signals. The one exception is **SIGHUP**; in that
998 case, when dc(1) is in TTY mode, a **SIGHUP** will cause dc(1) to clean up and
1001 # COMMAND LINE HISTORY
1003 dc(1) supports interactive command-line editing. If dc(1) is in TTY mode (see
1004 the **TTY MODE** section), history is enabled. Previous lines can be recalled
1005 and edited with the arrow keys.
1007 **Note**: tabs are converted to 8 spaces.
1011 This dc(1) ships with support for adding error messages for different locales
1012 and thus, supports **LC_MESSAGS**.
1020 The dc(1) utility operators are compliant with the operators in the bc(1)
1021 [IEEE Std 1003.1-2017 (“POSIX.1-2017”)][1] specification.
1025 None are known. Report bugs at https://git.yzena.com/gavin/bc.
1029 Gavin D. Howard <gavin@yzena.com> and contributors.
1031 [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html