diff options
117 files changed, 26194 insertions, 23082 deletions
diff --git a/contrib/bc/.gitignore b/contrib/bc/.gitignore index 85681bf6b48e..fb9bc5ab6aa2 100644 --- a/contrib/bc/.gitignore +++ b/contrib/bc/.gitignore @@ -9,6 +9,7 @@ bin/*bc bin/*bc.exe bin/*dc bin/*dc.exe +bin/bcl bc.old *.o *.a diff --git a/contrib/bc/Makefile.in b/contrib/bc/Makefile.in index 53f782c02791..4cc653b6a5cd 100644 --- a/contrib/bc/Makefile.in +++ b/contrib/bc/Makefile.in @@ -29,33 +29,13 @@ # .POSIX: -VERSION = 3.1.6 +VERSION = 3.2.0 SRC = %%SRC%% OBJ = %%OBJ%% GCDA = %%GCDA%% GCNO = %%GCNO%% -BC_SRC = %%BC_SRC%% -BC_OBJ = %%BC_OBJ%% -BC_GCDA = %%BC_GCDA%% -BC_GCNO = %%BC_GCNO%% - -DC_SRC = %%DC_SRC%% -DC_OBJ = %%DC_OBJ%% -DC_GCDA = %%DC_GCDA%% -DC_GCNO = %%DC_GCNO%% - -HISTORY_SRC = %%HISTORY_SRC%% -HISTORY_OBJ = %%HISTORY_OBJ%% -HISTORY_GCDA = %%HISTORY_GCDA%% -HISTORY_GCNO = %%HISTORY_GCNO%% - -RAND_SRC = %%RAND_SRC%% -RAND_OBJ = %%RAND_OBJ%% -RAND_GCDA = %%RAND_GCDA%% -RAND_GCNO = %%RAND_GCNO%% - BC_ENABLED_NAME = BC_ENABLED BC_ENABLED = %%BC_ENABLED%% DC_ENABLED_NAME = DC_ENABLED @@ -102,6 +82,13 @@ DC = dc BC_EXEC = $(BIN)/$(EXEC_PREFIX)$(BC) DC_EXEC = $(BIN)/$(EXEC_PREFIX)$(DC) +LIB = libbcl +LIB_NAME = $(LIB).a +LIBBC = $(BIN)/$(LIB_NAME) +BCL = bcl +BCL_TEST = $(BIN)/$(BCL) +BCL_TEST_C = tests/$(BCL).c + MANUALS = manuals BC_MANPAGE_NAME = $(EXEC_PREFIX)$(BC)$(EXEC_SUFFIX).1 BC_MANPAGE = $(MANUALS)/$(BC).1 @@ -109,16 +96,28 @@ BC_MD = $(BC_MANPAGE).md DC_MANPAGE_NAME = $(EXEC_PREFIX)$(DC)$(EXEC_SUFFIX).1 DC_MANPAGE = $(MANUALS)/$(DC).1 DC_MD = $(DC_MANPAGE).md +BCL_MANPAGE_NAME = bcl.3 +BCL_MANPAGE = $(MANUALS)/$(BCL_MANPAGE_NAME) +BCL_MD = $(BCL_MANPAGE).md MANPAGE_INSTALL_ARGS = -Dm644 +BINARY_INSTALL_ARGS = -Dm755 + +BCL_HEADER_NAME = bcl.h +BCL_HEADER = include/$(BCL_HEADER_NAME) %%DESTDIR%% BINDIR = %%BINDIR%% +INCLUDEDIR = %%INCLUDEDIR%% +LIBDIR = %%LIBDIR%% MAN1DIR = %%MAN1DIR%% +MAN3DIR = %%MAN3DIR%% MAIN_EXEC = $(EXEC_PREFIX)$(%%MAIN_EXEC%%)$(EXEC_SUFFIX) EXEC = $(%%EXEC%%) NLSPATH = %%NLSPATH%% +BC_ENABLE_LIBRARY = %%LIBRARY%% + BC_ENABLE_HISTORY = %%HISTORY%% BC_ENABLE_EXTRA_MATH_NAME = BC_ENABLE_EXTRA_MATH BC_ENABLE_EXTRA_MATH = %%EXTRA_MATH%% @@ -129,7 +128,7 @@ BC_LONG_BIT = %%LONG_BIT%% RM = rm MKDIR = mkdir -INSTALL = ./install.sh +INSTALL = ./exec-install.sh SAFE_INSTALL = ./safe-install.sh LINK = ./link.sh MANPAGE = ./manpage.sh @@ -148,7 +147,7 @@ CPPFLAGS4 = $(CPPFLAGS3) -D_POSIX_C_SOURCE=200809L -D_XOPEN_SOURCE=700 CPPFLAGS5 = $(CPPFLAGS4) -DBC_NUM_KARATSUBA_LEN=$(BC_NUM_KARATSUBA_LEN) CPPFLAGS6 = $(CPPFLAGS5) -DBC_ENABLE_NLS=$(BC_ENABLE_NLS) -DBC_ENABLE_PROMPT=$(BC_ENABLE_PROMPT) CPPFLAGS7 = $(CPPFLAGS6) -D$(BC_ENABLE_EXTRA_MATH_NAME)=$(BC_ENABLE_EXTRA_MATH) -CPPFLAGS = $(CPPFLAGS7) -DBC_ENABLE_HISTORY=$(BC_ENABLE_HISTORY) +CPPFLAGS = $(CPPFLAGS7) -DBC_ENABLE_HISTORY=$(BC_ENABLE_HISTORY) -DBC_ENABLE_LIBRARY=$(BC_ENABLE_LIBRARY) CFLAGS = $(CPPFLAGS) %%CPPFLAGS%% %%CFLAGS%% LDFLAGS = %%LDFLAGS%% @@ -157,21 +156,24 @@ HOSTCFLAGS = %%HOSTCFLAGS%% CC = %%CC%% HOSTCC = %%HOSTCC%% -BC_LIB_C_ARGS = bc_lib bc.h bc_lib_name $(BC_ENABLED_NAME) 1 -BC_LIB2_C_ARGS = bc_lib2 bc.h bc_lib2_name "$(BC_ENABLED_NAME) && $(BC_ENABLE_EXTRA_MATH_NAME)" 1 +BC_LIB_C_ARGS = bc_lib bc_lib_name $(BC_ENABLED_NAME) 1 +BC_LIB2_C_ARGS = bc_lib2 bc_lib2_name "$(BC_ENABLED_NAME) && $(BC_ENABLE_EXTRA_MATH_NAME)" 1 -OBJS1 = $(OBJ) $(DC_OBJ) $(BC_OBJ) $(HISTORY_OBJ) $(RAND_OBJ) $(BC_HELP_O) $(DC_HELP_O) -OBJS = $(OBJS1) $(BC_LIB_O) $(BC_LIB2_O) $(BC_LIB3_O) -OBJ_TARGETS1 = $(DC_HELP_O) $(BC_HELP_O) $(BC_LIB_O) $(BC_LIB2_O) $(BC_LIB3_O) -OBJ_TARGETS = $(OBJ_TARGETS1) $(BC_OBJ) $(DC_OBJ) $(HISTORY_OBJ) $(RAND_OBJ) $(OBJ) +OBJS = $(BC_HELP_O) $(DC_HELP_O) $(BC_LIB_O) $(BC_LIB2_O) $(OBJ) +OBJ_TARGETS = $(DC_HELP_O) $(BC_HELP_O) $(BC_LIB_O) $(BC_LIB2_O) $(OBJ) .c.o: $(CC) $(CFLAGS) -o $@ -c $< -all: make_bin $(OBJ_TARGETS) +all: %%ALL_PREREQ%% + +execs: make_bin $(OBJ_TARGETS) $(CC) $(CFLAGS) $(OBJS) $(LDFLAGS) -o $(EXEC) %%LINK%% +library: make_bin $(OBJ) $(BC_LIB_O) $(BC_LIB2_O) + ar -r -cu $(LIBBC) $(BC_LIB_O) $(BC_LIB2_O) $(OBJ) + $(GEN_EXEC): %%GEN_EXEC_TARGET%% @@ -182,10 +184,10 @@ $(BC_LIB2_C): $(GEN_EXEC) $(BC_LIB2) $(GEN_EMU) $(GEN_EXEC) $(BC_LIB2) $(BC_LIB2_C) $(BC_LIB2_C_ARGS) $(BC_HELP_C): $(GEN_EXEC) $(BC_HELP) - $(GEN_EMU) $(GEN_EXEC) $(BC_HELP) $(BC_HELP_C) bc_help bc.h "" $(BC_ENABLED_NAME) + $(GEN_EMU) $(GEN_EXEC) $(BC_HELP) $(BC_HELP_C) bc_help "" $(BC_ENABLED_NAME) $(DC_HELP_C): $(GEN_EXEC) $(DC_HELP) - $(GEN_EMU) $(GEN_EXEC) $(DC_HELP) $(DC_HELP_C) dc_help dc.h "" $(DC_ENABLED_NAME) + $(GEN_EMU) $(GEN_EXEC) $(DC_HELP) $(DC_HELP_C) dc_help "" $(DC_ENABLED_NAME) make_bin: $(MKDIR) -p $(BIN) @@ -222,7 +224,7 @@ help: check: test -test: test_bc timeconst test_dc +test: %%TESTS%% test_bc: %%BC_TEST%% @@ -241,6 +243,12 @@ time_test_dc: timeconst: %%TIMECONST%% +library_test: library + $(CC) $(CFLAGS) $(BCL_TEST_C) $(LIBBC) -o $(BCL_TEST) + +test_library: library_test + $(BCL_TEST) + valgrind: valgrind_bc valgrind_dc valgrind_bc: @@ -272,6 +280,7 @@ extra_math: manpages: $(MANPAGE) bc $(MANPAGE) dc + $(MANPAGE) bcl clean_gen: @$(RM) -f $(GEN_EXEC) @@ -279,10 +288,6 @@ clean_gen: clean:%%CLEAN_PREREQS%% @printf 'Cleaning files...\n' @$(RM) -f $(OBJ) - @$(RM) -f $(BC_OBJ) - @$(RM) -f $(DC_OBJ) - @$(RM) -f $(HISTORY_OBJ) - @$(RM) -f $(RAND_OBJ) @$(RM) -f $(BC_EXEC) @$(RM) -f $(DC_EXEC) @$(RM) -fr $(BIN) @@ -343,9 +348,20 @@ install_bc_manpage: install_dc_manpage: $(SAFE_INSTALL) $(MANPAGE_INSTALL_ARGS) $(DC_MANPAGE) $(DESTDIR)$(MAN1DIR)/$(DC_MANPAGE_NAME) -install:%%INSTALL_LOCALES_PREREQS%%%%INSTALL_PREREQS%% +install_bcl_manpage: + $(SAFE_INSTALL) $(MANPAGE_INSTALL_ARGS) $(BCL_MANPAGE) $(DESTDIR)$(MAN3DIR)/$(BCL_MANPAGE_NAME) + +install_bcl_header: + $(SAFE_INSTALL) $(MANPAGE_INSTALL_ARGS) $(BCL_HEADER) $(DESTDIR)$(INCLUDEDIR)/$(BCL_HEADER_NAME) + +install_execs: $(INSTALL) $(DESTDIR)$(BINDIR) "$(EXEC_SUFFIX)" +install_library: + $(SAFE_INSTALL) $(BINARY_INSTALL_ARGS) $(LIBBC) $(DESTDIR)$(LIBDIR)/$(LIB_NAME) + +install:%%INSTALL_LOCALES_PREREQS%%%%INSTALL_MAN_PREREQS%%%%INSTALL_PREREQS%% + uninstall_locales: $(LOCALE_UNINSTALL) $(NLSPATH) $(MAIN_EXEC) $(DESTDIR) @@ -361,4 +377,13 @@ uninstall_dc_manpage: uninstall_dc: $(RM) -f $(DESTDIR)$(BINDIR)/$(EXEC_PREFIX)$(DC)$(EXEC_SUFFIX) +uninstall_library: + $(RM) -f $(DESTDIR)$(LIBDIR)/$(LIB_NAME) + +uninstall_bcl_header: + $(RM) -f $(DESTDIR)$(INCLUDEDIR)/$(BCL_HEADER_NAME) + +uninstall_bcl_manpage: + $(RM) -f $(DESTDIR)$(MAN3DIR)/$(BCL_MANPAGE_NAME) + uninstall:%%UNINSTALL_LOCALES_PREREQS%%%%UNINSTALL_MAN_PREREQS%%%%UNINSTALL_PREREQS%% diff --git a/contrib/bc/NEWS.md b/contrib/bc/NEWS.md index af7f21c48fa6..d200187e23ce 100644 --- a/contrib/bc/NEWS.md +++ b/contrib/bc/NEWS.md @@ -1,5 +1,23 @@ # News +## 3.2.0 + +This is a production release that has one bug fix and a major addition. + +The bug fix was a missing `auto` variable in the bessel `j()` function in the +math library. + +The major addition is a way to build a version of `bc`'s math code as a library. +This is done with the `-a` option to `configure.sh`. The API for the library can +be read in `./manuals/bcl.3.md` or `man bcl` once the library is installed with +`make install`. + +This library was requested by developers before I even finished version 1.0, but +I could not figure out how to do it until now. + +If the library has API breaking changes, the major version of `bc` will be +incremented. + ## 3.1.6 This is a production release that fixes a new warning from Clang 12 for FreeBSD diff --git a/contrib/bc/README.md b/contrib/bc/README.md index 8aacb21b004c..cea5d877b95c 100644 --- a/contrib/bc/README.md +++ b/contrib/bc/README.md @@ -107,6 +107,23 @@ other locations, use the `PREFIX` environment variable when running `configure.sh` or pass the `--prefix=<prefix>` option to `configure.sh`. See the [build manual][5], or run `./configure.sh --help`, for more details. +### Library + +This `bc` does provide a way to build a math library with C bindings. This is +done by the `-a` or `--library` options to `configure.sh`: + +``` +./configure.sh -a +``` + +When building the library, the executables are not built. For more information, +see the [build manual][5]. + +The library API can be found in [`manuals/bcl.3.md`][26] or `man bcl` once the +library is installed. + +The library is built as `bin/libbcl.a`. + ### Package and Distro Maintainers #### Recommended Compiler @@ -335,3 +352,4 @@ Folders: [23]: https://svnweb.freebsd.org/base/head/contrib/bc/ [24]: https://bugs.freebsd.org/ [25]: https://reviews.freebsd.org/ +[26]: ./manuals/bcl.3.md diff --git a/contrib/bc/configure.sh b/contrib/bc/configure.sh index 9490787ffa21..b41bee445594 100755 --- a/contrib/bc/configure.sh +++ b/contrib/bc/configure.sh @@ -45,22 +45,27 @@ usage() { _usage_val=0 fi - printf 'usage: %s -h\n' "$script" - printf ' %s --help\n' "$script" - printf ' %s [-bD|-dB|-c] [-EfgGHlMNPT] [-O OPT_LEVEL] [-k KARATSUBA_LEN]\n' "$script" - printf ' %s \\\n' "$script" - printf ' [--bc-only --disable-dc|--dc-only --disable-bc|--coverage] \\\n' - printf ' [--debug --disable-extra-math --disable-generated-tests] \\\n' - printf ' [--disable-history --disable-man-pages --disable-nls] \\\n' - printf ' [--disable-prompt --disable-strip] [--install-all-locales] \\\n' - printf ' [--opt=OPT_LEVEL] [--karatsuba-len=KARATSUBA_LEN] \\\n' - printf ' [--prefix=PREFIX] [--bindir=BINDIR] [--datarootdir=DATAROOTDIR] \\\n' - printf ' [--datadir=DATADIR] [--mandir=MANDIR] [--man1dir=MAN1DIR] \\\n' - printf ' [--force] \\\n' + printf 'usage:\n' + printf ' %s -h\n' "$script" + printf ' %s --help\n' "$script" + printf ' %s [-a|-bD|-dB|-c] [-EfgGHlMNPT] [-O OPT_LEVEL] [-k KARATSUBA_LEN]\n' "$script" + printf ' %s \\\n' "$script" + printf ' [--library|--bc-only --disable-dc|--dc-only --disable-bc|--coverage]\\\n' + printf ' [--force --debug --disable-extra-math --disable-generated-tests] \\\n' + printf ' [--disable-history --disable-man-pages --disable-nls] \\\n' + printf ' [--disable-prompt --disable-strip] [--install-all-locales] \\\n' + printf ' [--opt=OPT_LEVEL] [--karatsuba-len=KARATSUBA_LEN] \\\n' + printf ' [--prefix=PREFIX] [--bindir=BINDIR] [--datarootdir=DATAROOTDIR] \\\n' + printf ' [--datadir=DATADIR] [--mandir=MANDIR] [--man1dir=MAN1DIR] \\\n' printf '\n' + printf ' -a, --library\n' + printf ' Build the libbc instead of the programs. This is meant to be used with\n' + printf ' Other software like programming languages that want to make use of the\n' + printf ' parsing and math capabilities. This option will install headers using\n' + printf ' `make install`.\n' printf ' -b, --bc-only\n' - printf ' Build bc only. It is an error if "-d", "--dc-only", "-B", or "--disable-bc"\n' - printf ' are specified too.\n' + printf ' Build bc only. It is an error if "-d", "--dc-only", "-B", or\n' + printf ' "--disable-bc" are specified too.\n' printf ' -B, --disable-bc\n' printf ' Disable bc. It is an error if "-b", "--bc-only", "-D", or "--disable-dc"\n' printf ' are specified too.\n' @@ -69,10 +74,10 @@ usage() { printf ' It is an error if either "-b" ("-D") or "-d" ("-B") is specified.\n' printf ' Requires a compiler that use gcc-compatible coverage options\n' printf ' -d, --dc-only\n' - printf ' Build dc only. It is an error if "-b", "--bc-only", "-D", or "--disable-dc"\n' - printf ' are specified too.\n' + printf ' Build dc only. It is an error if "-b", "--bc-only", "-D", or\n' + printf ' "--disable-dc" are specified too.\n' printf ' -D, --disable-dc\n' - printf ' Disable dc. It is an error if "-d", "--dc-only" "-B", or "--disable-bc"\n' + printf ' Disable dc. It is an error if "-d", "--dc-only", "-B", or "--disable-bc"\n' printf ' are specified too.\n' printf ' -E, --disable-extra-math\n' printf ' Disable extra math. This includes: "$" operator (truncate to integer),\n' @@ -122,8 +127,14 @@ usage() { printf ' If PREFIX is "/usr", install path will be "/usr/bin".\n' printf ' Default is "/usr/local".\n' printf ' --bindir BINDIR\n' - printf ' The directory to install binaries. Overrides "$BINDIR" if it exists.\n' + printf ' The directory to install binaries in. Overrides "$BINDIR" if it exists.\n' printf ' Default is "$PREFIX/bin".\n' + printf ' --includedir INCLUDEDIR\n' + printf ' The directory to install headers in. Overrides "$INCLUDEDIR" if it\n' + printf ' exists. Default is "$PREFIX/include".\n' + printf ' --libdir LIBDIR\n' + printf ' The directory to install libraries in. Overrides "$LIBDIR" if it exists.\n' + printf ' Default is "$PREFIX/lib".\n' printf ' --datarootdir DATAROOTDIR\n' printf ' The root location for data files. Overrides "$DATAROOTDIR" if it exists.\n' printf ' Default is "$PREFIX/share".\n' @@ -136,6 +147,9 @@ usage() { printf ' --man1dir MAN1DIR\n' printf ' The location to install Section 1 manpages to. Overrides "$MAN1DIR" if\n' printf ' it exists. Default is "$MANDIR/man1".\n' + printf ' --man3dir MAN3DIR\n' + printf ' The location to install Section 3 manpages to. Overrides "$MAN3DIR" if\n' + printf ' it exists. Default is "$MANDIR/man3".\n' printf '\n' printf 'In addition, the following environment variables are used:\n' printf '\n' @@ -157,12 +171,18 @@ usage() { printf ' LDFLAGS Linker flags. Default is "".\n' printf ' PREFIX The prefix to install to. Default is "/usr/local".\n' printf ' If PREFIX is "/usr", install path will be "/usr/bin".\n' - printf ' BINDIR The directory to install binaries. Default is "$PREFIX/bin".\n' + printf ' BINDIR The directory to install binaries in. Default is "$PREFIX/bin".\n' + printf ' INCLUDEDIR The directory to install header files in. Default is\n' + printf ' "$PREFIX/include".\n' + printf ' LIBDIR The directory to install libraries in. Default is\n' + printf ' "$PREFIX/lib".\n' printf ' DATAROOTDIR The root location for data files. Default is "$PREFIX/share".\n' printf ' DATADIR The location for data files. Default is "$DATAROOTDIR".\n' printf ' MANDIR The location to install manpages to. Default is "$DATADIR/man".\n' printf ' MAN1DIR The location to install Section 1 manpages to. Default is\n' printf ' "$MANDIR/man1".\n' + printf ' MAN3DIR The location to install Section 3 manpages to. Default is\n' + printf ' "$MANDIR/man3".\n' printf ' NLSPATH The location to install locale catalogs to. Must be an absolute\n' printf ' path (or contain one). This is treated the same as the POSIX\n' printf ' definition of $NLSPATH (see POSIX environment variables for\n' @@ -257,56 +277,55 @@ replace() { substring_replace "$_replace_str" "%%$_replace_needle%%" "$_replace_replacement" } -gen_file_lists() { +gen_file_list() { - if [ "$#" -lt 3 ]; then + if [ "$#" -lt 1 ]; then err_exit "Invalid number of args to $0" fi - _gen_file_lists_contents="$1" + _gen_file_list_contents="$1" shift - _gen_file_lists_filedir="$1" - shift + p=$(pwd) - _gen_file_lists_typ="$1" - shift + cd "$scriptdir" + + if [ "$#" -ge 1 ]; then + + while [ "$#" -ge 1 ]; do + a="$1" + shift + args="$args ! -wholename src/${a}" + done - # If there is an extra argument, and it - # is zero, we keep the file lists empty. - if [ "$#" -gt 0 ]; then - _gen_file_lists_use="$1" else - _gen_file_lists_use="1" + args="-print" fi - _gen_file_lists_needle_src="${_gen_file_lists_typ}SRC" - _gen_file_lists_needle_obj="${_gen_file_lists_typ}OBJ" - _gen_file_lists_needle_gcda="${_gen_file_lists_typ}GCDA" - _gen_file_lists_needle_gcno="${_gen_file_lists_typ}GCNO" + _gen_file_list_needle_src="SRC" + _gen_file_list_needle_obj="OBJ" + _gen_file_list_needle_gcda="GCDA" + _gen_file_list_needle_gcno="GCNO" - if [ "$_gen_file_lists_use" -ne 0 ]; then + _gen_file_list_replacement=$(find src/ -depth -name "*.c" $args | tr '\n' ' ') + _gen_file_list_contents=$(replace "$_gen_file_list_contents" \ + "$_gen_file_list_needle_src" "$_gen_file_list_replacement") - _gen_file_lists_replacement=$(cd "$_gen_file_lists_filedir" && find . ! -name . -prune -name "*.c" | cut -d/ -f2 | sed "s@^@$_gen_file_lists_filedir/@g" | tr '\n' ' ') - _gen_file_lists_contents=$(replace "$_gen_file_lists_contents" "$_gen_file_lists_needle_src" "$_gen_file_lists_replacement") + _gen_file_list_replacement=$(replace_exts "$_gen_file_list_replacement" "c" "o") + _gen_file_list_contents=$(replace "$_gen_file_list_contents" \ + "$_gen_file_list_needle_obj" "$_gen_file_list_replacement") - _gen_file_lists_replacement=$(replace_exts "$_gen_file_lists_replacement" "c" "o") - _gen_file_lists_contents=$(replace "$_gen_file_lists_contents" "$_gen_file_lists_needle_obj" "$_gen_file_lists_replacement") + _gen_file_list_replacement=$(replace_exts "$_gen_file_list_replacement" "o" "gcda") + _gen_file_list_contents=$(replace "$_gen_file_list_contents" \ + "$_gen_file_list_needle_gcda" "$_gen_file_list_replacement") - _gen_file_lists_replacement=$(replace_exts "$_gen_file_lists_replacement" "o" "gcda") - _gen_file_lists_contents=$(replace "$_gen_file_lists_contents" "$_gen_file_lists_needle_gcda" "$_gen_file_lists_replacement") + _gen_file_list_replacement=$(replace_exts "$_gen_file_list_replacement" "gcda" "gcno") + _gen_file_list_contents=$(replace "$_gen_file_list_contents" \ + "$_gen_file_list_needle_gcno" "$_gen_file_list_replacement") - _gen_file_lists_replacement=$(replace_exts "$_gen_file_lists_replacement" "gcda" "gcno") - _gen_file_lists_contents=$(replace "$_gen_file_lists_contents" "$_gen_file_lists_needle_gcno" "$_gen_file_lists_replacement") + cd "$p" - else - _gen_file_lists_contents=$(replace "$_gen_file_lists_contents" "$_gen_file_lists_needle_src" "") - _gen_file_lists_contents=$(replace "$_gen_file_lists_contents" "$_gen_file_lists_needle_obj" "") - _gen_file_lists_contents=$(replace "$_gen_file_lists_contents" "$_gen_file_lists_needle_gcda" "") - _gen_file_lists_contents=$(replace "$_gen_file_lists_contents" "$_gen_file_lists_needle_gcno" "") - fi - - printf '%s\n' "$_gen_file_lists_contents" + printf '%s\n' "$_gen_file_list_contents" } bc_only=0 @@ -324,10 +343,12 @@ prompt=1 force=0 strip_bin=1 all_locales=0 +library=0 -while getopts "bBcdDEfgGhHk:lMNO:PST-" opt; do +while getopts "abBcdDEfgGhHk:lMNO:PST-" opt; do case "$opt" in + a) library=1 ;; b) bc_only=1 ;; B) dc_only=1 ;; c) coverage=1 ;; @@ -352,6 +373,7 @@ while getopts "bBcdDEfgGhHk:lMNO:PST-" opt; do LONG_OPTARG="${arg#*=}" case $arg in help) usage ;; + library) library=1 ;; bc-only) bc_only=1 ;; dc-only) dc_only=1 ;; coverage) coverage=1 ;; @@ -371,6 +393,20 @@ while getopts "bBcdDEfgGhHk:lMNO:PST-" opt; do fi BINDIR="$2" shift ;; + includedir=?*) INCLUDEDIR="$LONG_OPTARG" ;; + includedir) + if [ "$#" -lt 2 ]; then + usage "No argument given for '--$arg' option" + fi + INCLUDEDIR="$2" + shift ;; + libdir=?*) LIBDIR="$LONG_OPTARG" ;; + libdir) + if [ "$#" -lt 2 ]; then + usage "No argument given for '--$arg' option" + fi + LIBDIR="$2" + shift ;; datarootdir=?*) DATAROOTDIR="$LONG_OPTARG" ;; datarootdir) if [ "$#" -lt 2 ]; then @@ -399,6 +435,13 @@ while getopts "bBcdDEfgGhHk:lMNO:PST-" opt; do fi MAN1DIR="$2" shift ;; + man3dir=?*) MAN3DIR="$LONG_OPTARG" ;; + man3dir) + if [ "$#" -lt 2 ]; then + usage "No argument given for '--$arg' option" + fi + MAN3DIR="$2" + shift ;; localedir=?*) LOCALEDIR="$LONG_OPTARG" ;; localedir) if [ "$#" -lt 2 ]; then @@ -454,6 +497,12 @@ if [ "$bc_only" -eq 1 ] && [ "$dc_only" -eq 1 ]; then usage "Can only specify one of -b(-D) or -d(-B)" fi +if [ "$library" -ne 0 ]; then + if [ "$bc_only" -eq 1 ] || [ "$dc_only" -eq 1 ]; then + usage "Must not specify -b(-D) or -d(-B) when building the library" + fi +fi + case $karatsuba_len in (*[!0-9]*|'') usage "KARATSUBA_LEN is not a number" ;; (*) ;; @@ -529,6 +578,8 @@ link="@printf 'No link necessary\\\\n'" main_exec="BC" executable="BC_EXEC" +tests="test_bc timeconst test_dc" + bc_test="@tests/all.sh bc $extra_math 1 $generate_tests 0 \$(BC_EXEC)" bc_time_test="@tests/all.sh bc $extra_math 1 $generate_tests 1 \$(BC_EXEC)" @@ -567,7 +618,8 @@ if [ "$bc_only" -eq 1 ]; then dc_time_test="@printf 'No dc tests to run\\\\n'" vg_dc_test="@printf 'No dc tests to run\\\\n'" - install_prereqs=" install_bc_manpage" + install_prereqs=" install_execs" + install_man_prereqs=" install_bc_manpage" uninstall_prereqs=" uninstall_bc" uninstall_man_prereqs=" uninstall_bc_manpage" @@ -590,7 +642,8 @@ elif [ "$dc_only" -eq 1 ]; then timeconst="@printf 'timeconst cannot be run because bc is not built\\\\n'" - install_prereqs=" install_dc_manpage" + install_prereqs=" install_execs" + install_man_prereqs=" install_dc_manpage" uninstall_prereqs=" uninstall_dc" uninstall_man_prereqs=" uninstall_dc_manpage" @@ -606,9 +659,18 @@ else karatsuba="@\$(KARATSUBA) 30 0 \$(BC_EXEC)" karatsuba_test="@\$(KARATSUBA) 1 100 \$(BC_EXEC)" - install_prereqs=" install_bc_manpage install_dc_manpage" - uninstall_prereqs=" uninstall_bc uninstall_dc" - uninstall_man_prereqs=" uninstall_bc_manpage uninstall_dc_manpage" + if [ "$library" -eq 0 ]; then + install_prereqs=" install_execs" + install_man_prereqs=" install_bc_manpage install_dc_manpage" + uninstall_prereqs=" uninstall_bc uninstall_dc" + uninstall_man_prereqs=" uninstall_bc_manpage uninstall_dc_manpage" + else + install_prereqs=" install_library install_bcl_header" + install_man_prereqs=" install_bcl_manpage" + uninstall_prereqs=" uninstall_library uninstall_bcl_header" + uninstall_man_prereqs=" uninstall_bcl_manpage" + tests="test_library" + fi fi @@ -664,6 +726,14 @@ if [ -z "${BINDIR+set}" ]; then BINDIR="$PREFIX/bin" fi +if [ -z "${INCLUDEDIR+set}" ]; then + INCLUDEDIR="$PREFIX/include" +fi + +if [ -z "${LIBDIR+set}" ]; then + LIBDIR="$PREFIX/lib" +fi + if [ "$install_manpages" -ne 0 ] || [ "$nls" -ne 0 ]; then if [ -z "${DATAROOTDIR+set}" ]; then DATAROOTDIR="$PREFIX/share" @@ -684,11 +754,25 @@ if [ "$install_manpages" -ne 0 ]; then MAN1DIR="$MANDIR/man1" fi + if [ -z "${MAN3DIR+set}" ]; then + MAN3DIR="$MANDIR/man3" + fi + else - install_prereqs="" + install_man_prereqs="" uninstall_man_prereqs="" fi +if [ "$library" -ne 0 ]; then + extra_math=1 + nls=0 + hist=0 + prompt=0 + ALL_PREREQ="library" +else + ALL_PREREQ="execs" +fi + if [ "$nls" -ne 0 ]; then set +e @@ -776,11 +860,11 @@ if [ "$hist" -eq 1 ]; then printf 'Testing history...\n' flags="-DBC_ENABLE_HISTORY=1 -DBC_ENABLED=$bc -DDC_ENABLED=$dc" - flags="$flags -DBC_ENABLE_NLS=$nls" + flags="$flags -DBC_ENABLE_NLS=$nls -DBC_ENABLE_LIBRARY=0" flags="$flags -DBC_ENABLE_EXTRA_MATH=$extra_math -I./include/" flags="$flags -D_POSIX_C_SOURCE=200809L -D_XOPEN_SOURCE=700" - "$CC" $CPPFLAGS $CFLAGS $flags -c "src/history/history.c" -o "$scriptdir/history.o" > /dev/null 2>&1 + "$CC" $CPPFLAGS $CFLAGS $flags -c "src/history.c" -o "$scriptdir/history.o" > /dev/null 2>&1 err="$?" @@ -804,7 +888,11 @@ if [ "$hist" -eq 1 ]; then fi -if [ "$extra_math" -eq 1 ] && [ "$bc" -ne 0 ]; then +if [ "$library" -eq 1 ]; then + bc_lib="" +fi + +if [ "$extra_math" -eq 1 ] && [ "$bc" -ne 0 ] && [ "$library" -eq 0 ]; then BC_LIB2_O="\$(GEN_DIR)/lib2.o" else BC_LIB2_O="" @@ -846,6 +934,33 @@ if [ "$manpage_args" = "" ]; then manpage_args="A" fi +unneeded="" + +if [ "$hist" -eq 0 ]; then + unneeded="$unneeded history.c" +fi + +if [ "$bc" -eq 0 ]; then + unneeded="$unneeded bc.c bc_lex.c bc_parse.c" +fi + +if [ "$dc" -eq 0 ]; then + unneeded="$unneeded dc.c dc_lex.c dc_parse.c" +fi + +if [ "$extra_math" -eq 0 ]; then + unneeded="$unneeded rand.c" +fi + +if [ "$library" -ne 0 ]; then + unneeded="$unneeded args.c opt.c read.c file.c main.c" + unneeded="$unneeded lang.c lex.c parse.c program.c" + unneeded="$unneeded bc.c bc_lex.c bc_parse.c" + unneeded="$unneeded dc.c dc_lex.c dc_parse.c" +else + unneeded="$unneeded library.c" +fi + # Print out the values; this is for debugging. if [ "$bc" -ne 0 ]; then printf 'Building bc\n' @@ -858,6 +973,7 @@ else printf 'Not building dc\n' fi printf '\n' +printf 'BC_ENABLE_LIBRARY=%s\n\n' "$library" printf 'BC_ENABLE_HISTORY=%s\n' "$hist" printf 'BC_ENABLE_EXTRA_MATH=%s\n' "$extra_math" printf 'BC_ENABLE_NLS=%s\n' "$nls" @@ -873,10 +989,13 @@ printf 'CPPFLAGS=%s\n' "$CPPFLAGS" printf 'LDFLAGS=%s\n' "$LDFLAGS" printf 'PREFIX=%s\n' "$PREFIX" printf 'BINDIR=%s\n' "$BINDIR" +printf 'INCLUDEDIR=%s\n' "$INCLUDEDIR" +printf 'LIBDIR=%s\n' "$LIBDIR" printf 'DATAROOTDIR=%s\n' "$DATAROOTDIR" printf 'DATADIR=%s\n' "$DATADIR" printf 'MANDIR=%s\n' "$MANDIR" printf 'MAN1DIR=%s\n' "$MAN1DIR" +printf 'MAN3DIR=%s\n' "$MAN3DIR" printf 'NLSPATH=%s\n' "$NLSPATH" printf 'EXECSUFFIX=%s\n' "$EXECSUFFIX" printf 'EXECPREFIX=%s\n' "$EXECPREFIX" @@ -892,16 +1011,17 @@ replacement='*** WARNING: Autogenerated from Makefile.in. DO NOT MODIFY ***' contents=$(replace "$contents" "$needle" "$replacement") -contents=$(gen_file_lists "$contents" "$scriptdir/src" "") -contents=$(gen_file_lists "$contents" "$scriptdir/src/bc" "BC_" "$bc") -contents=$(gen_file_lists "$contents" "$scriptdir/src/dc" "DC_" "$dc") -contents=$(gen_file_lists "$contents" "$scriptdir/src/history" "HISTORY_" "$hist") -contents=$(gen_file_lists "$contents" "$scriptdir/src/rand" "RAND_" "$extra_math") +if [ "$unneeded" = "" ]; then + contents=$(gen_file_list "$contents" "library.c") +else + contents=$(gen_file_list "$contents" $unneeded) +fi contents=$(replace "$contents" "BC_ENABLED" "$bc") contents=$(replace "$contents" "DC_ENABLED" "$dc") contents=$(replace "$contents" "LINK" "$link") +contents=$(replace "$contents" "LIBRARY" "$library") contents=$(replace "$contents" "HISTORY" "$hist") contents=$(replace "$contents" "EXTRA_MATH" "$extra_math") contents=$(replace "$contents" "NLS" "$nls") @@ -917,7 +1037,10 @@ contents=$(replace "$contents" "DESTDIR" "$destdir") contents=$(replace "$contents" "EXECSUFFIX" "$EXECSUFFIX") contents=$(replace "$contents" "EXECPREFIX" "$EXECPREFIX") contents=$(replace "$contents" "BINDIR" "$BINDIR") +contents=$(replace "$contents" "INCLUDEDIR" "$INCLUDEDIR") +contents=$(replace "$contents" "LIBDIR" "$LIBDIR") contents=$(replace "$contents" "MAN1DIR" "$MAN1DIR") +contents=$(replace "$contents" "MAN3DIR" "$MAN3DIR") contents=$(replace "$contents" "CFLAGS" "$CFLAGS") contents=$(replace "$contents" "HOSTCFLAGS" "$HOSTCFLAGS") contents=$(replace "$contents" "CPPFLAGS" "$CPPFLAGS") @@ -927,15 +1050,19 @@ contents=$(replace "$contents" "HOSTCC" "$HOSTCC") contents=$(replace "$contents" "COVERAGE_OUTPUT" "$COVERAGE_OUTPUT") contents=$(replace "$contents" "COVERAGE_PREREQS" "$COVERAGE_PREREQS") contents=$(replace "$contents" "INSTALL_PREREQS" "$install_prereqs") +contents=$(replace "$contents" "INSTALL_MAN_PREREQS" "$install_man_prereqs") contents=$(replace "$contents" "INSTALL_LOCALES" "$install_locales") contents=$(replace "$contents" "INSTALL_LOCALES_PREREQS" "$install_locales_prereqs") contents=$(replace "$contents" "UNINSTALL_MAN_PREREQS" "$uninstall_man_prereqs") contents=$(replace "$contents" "UNINSTALL_PREREQS" "$uninstall_prereqs") contents=$(replace "$contents" "UNINSTALL_LOCALES_PREREQS" "$uninstall_locales_prereqs") +contents=$(replace "$contents" "ALL_PREREQ" "$ALL_PREREQ") + contents=$(replace "$contents" "EXECUTABLES" "$executables") contents=$(replace "$contents" "MAIN_EXEC" "$main_exec") contents=$(replace "$contents" "EXEC" "$executable") +contents=$(replace "$contents" "TESTS" "$tests") contents=$(replace "$contents" "BC_TEST" "$bc_test") contents=$(replace "$contents" "BC_TIME_TEST" "$bc_time_test") diff --git a/contrib/bc/install.sh b/contrib/bc/exec-install.sh index 6d1600330ba9..6d1600330ba9 100755 --- a/contrib/bc/install.sh +++ b/contrib/bc/exec-install.sh diff --git a/contrib/bc/gen/lib.bc b/contrib/bc/gen/lib.bc index 93ac29546beb..7768eb74bad1 100644 --- a/contrib/bc/gen/lib.bc +++ b/contrib/bc/gen/lib.bc @@ -173,7 +173,7 @@ define a(x){ return((m*a+r)/n) } define j(n,x){ - auto b,s,o,a,i,v,f + auto b,s,o,a,i,r,v,f b=ibase ibase=A s=scale diff --git a/contrib/bc/gen/strgen.c b/contrib/bc/gen/strgen.c index f4c4b51d1248..0b2306152874 100644 --- a/contrib/bc/gen/strgen.c +++ b/contrib/bc/gen/strgen.c @@ -45,13 +45,14 @@ static const char* const bc_gen_header = "// Copyright (c) 2018-2020 Gavin D. Howard and contributors.\n" "// Licensed under the 2-clause BSD license.\n" - "// *** AUTOMATICALLY GENERATED FROM %s. DO NOT MODIFY. ***\n"; + "// *** AUTOMATICALLY GENERATED FROM %s. DO NOT MODIFY. ***\n\n"; -static const char* const bc_gen_include = "#include <%s>\n\n"; static const char* const bc_gen_label = "const char *%s = \"%s\";\n\n"; +static const char* const bc_gen_label_extern = "extern const char *%s;\n\n"; static const char* const bc_gen_ifdef = "#if %s\n"; static const char* const bc_gen_endif = "#endif // %s\n"; static const char* const bc_gen_name = "const char %s[] = {\n"; +static const char* const bc_gen_name_extern = "extern const char %s[];\n\n"; #define IO_ERR (1) #define INVALID_INPUT_FILE (2) @@ -62,7 +63,7 @@ static const char* const bc_gen_name = "const char %s[] = {\n"; int main(int argc, char *argv[]) { FILE *in, *out; - char *label, *define, *name, *include; + char *label, *define, *name; int c, count, slashes, err = IO_ERR; bool has_label, has_define, remove_tabs; @@ -72,15 +73,14 @@ int main(int argc, char *argv[]) { } name = argv[3]; - include = argv[4]; - has_label = (argc > 5 && strcmp("", argv[5]) != 0); - label = has_label ? argv[5] : ""; + has_label = (argc > 4 && strcmp("", argv[4]) != 0); + label = has_label ? argv[4] : ""; - has_define = (argc > 6 && strcmp("", argv[6]) != 0); - define = has_define ? argv[6] : ""; + has_define = (argc > 5 && strcmp("", argv[5]) != 0); + define = has_define ? argv[5] : ""; - remove_tabs = (argc > 7); + remove_tabs = (argc > 6); in = fopen(argv[1], "r"); if (!in) return INVALID_INPUT_FILE; @@ -89,8 +89,9 @@ int main(int argc, char *argv[]) { if (!out) goto out_err; if (fprintf(out, bc_gen_header, argv[1]) < 0) goto err; + if (has_label && fprintf(out, bc_gen_label_extern, label) < 0) goto err; + if (fprintf(out, bc_gen_name_extern, name) < 0) goto err; if (has_define && fprintf(out, bc_gen_ifdef, define) < 0) goto err; - if (fprintf(out, bc_gen_include, include) < 0) goto err; if (has_label && fprintf(out, bc_gen_label, label, argv[1]) < 0) goto err; if (fprintf(out, bc_gen_name, name) < 0) goto err; diff --git a/contrib/bc/gen/strgen.sh b/contrib/bc/gen/strgen.sh index f389c12c0579..d886ce54197d 100755 --- a/contrib/bc/gen/strgen.sh +++ b/contrib/bc/gen/strgen.sh @@ -32,7 +32,7 @@ export LC_CTYPE=C progname=${0##*/} -if [ $# -lt 4 ]; then +if [ $# -lt 3 ]; then echo "usage: $progname input output name header [label [define [remove_tabs]]]" exit 1 fi @@ -40,16 +40,16 @@ fi input="$1" output="$2" name="$3" -header="$4" -label="$5" -define="$6" -remove_tabs="$7" +label="$4" +define="$5" +remove_tabs="$6" exec < "$input" exec > "$output" if [ -n "$label" ]; then nameline="const char *${label} = \"${input}\";" + labelexternline="extern const char *${label};" fi if [ -n "$define" ]; then @@ -64,11 +64,14 @@ if [ -n "$remove_tabs" ]; then fi cat<<EOF +// Copyright (c) 2018-2020 Gavin D. Howard and contributors. // Licensed under the 2-clause BSD license. // *** AUTOMATICALLY GENERATED FROM ${input}. DO NOT MODIFY. *** ${condstart} -#include <${header}> +$labelexternline + +extern const char $name[]; $nameline diff --git a/contrib/bc/include/bcl.h b/contrib/bc/include/bcl.h new file mode 100644 index 000000000000..05f1631e5534 --- /dev/null +++ b/contrib/bc/include/bcl.h @@ -0,0 +1,184 @@ +/* + * ***************************************************************************** + * + * SPDX-License-Identifier: BSD-2-Clause + * + * Copyright (c) 2018-2020 Gavin D. Howard and contributors. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * * Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + * ***************************************************************************** + * + * The public header for the bc library. + * + */ + +#ifndef BC_BCL_H +#define BC_BCL_H + +#include <stdbool.h> +#include <stdlib.h> +#include <limits.h> +#include <stdint.h> +#include <sys/types.h> + +#define BC_SEED_ULONGS (4) +#define BC_SEED_SIZE (sizeof(long) * BC_SEED_ULONGS) + +// For some reason, LONG_BIT is not defined in some versions of gcc. +// I define it here to the minimum accepted value in the POSIX standard. +#ifndef LONG_BIT +#define LONG_BIT (32) +#endif // LONG_BIT + +#ifndef BC_LONG_BIT +#define BC_LONG_BIT LONG_BIT +#endif // BC_LONG_BIT + +#if BC_LONG_BIT > LONG_BIT +#error BC_LONG_BIT cannot be greater than LONG_BIT +#endif // BC_LONG_BIT > LONG_BIT + +#if BC_LONG_BIT >= 64 + +typedef uint64_t BclBigDig; +typedef uint64_t BclRandInt; + +#elif BC_LONG_BIT >= 32 + +typedef uint32_t BclBigDig; +typedef uint32_t BclRandInt; + +#else + +#error BC_LONG_BIT must be at least 32 + +#endif // BC_LONG_BIT >= 64 + +typedef enum BclError { + + BCL_ERROR_NONE, + + BCL_ERROR_INVALID_NUM, + BCL_ERROR_INVALID_CONTEXT, + BCL_ERROR_SIGNAL, + + BCL_ERROR_MATH_NEGATIVE, + BCL_ERROR_MATH_NON_INTEGER, + BCL_ERROR_MATH_OVERFLOW, + BCL_ERROR_MATH_DIVIDE_BY_ZERO, + + BCL_ERROR_PARSE_INVALID_STR, + + BCL_ERROR_FATAL_ALLOC_ERR, + BCL_ERROR_FATAL_UNKNOWN_ERR, + + BCL_ERROR_NELEMS, + +} BclError; + +typedef struct BclNumber { + + size_t i; + +} BclNumber; + +struct BclCtxt; + +typedef struct BclCtxt* BclContext; + +void bcl_handleSignal(void); +bool bcl_running(void); + +BclError bcl_init(void); +void bcl_free(void); + +bool bcl_abortOnFatalError(void); +void bcl_setAbortOnFatalError(bool abrt); + +void bcl_gc(void); + +BclError bcl_pushContext(BclContext ctxt); +void bcl_popContext(void); +BclContext bcl_context(void); + +BclContext bcl_ctxt_create(void); +void bcl_ctxt_free(BclContext ctxt); +void bcl_ctxt_freeNums(BclContext ctxt); + +size_t bcl_ctxt_scale(BclContext ctxt); +void bcl_ctxt_setScale(BclContext ctxt, size_t scale); +size_t bcl_ctxt_ibase(BclContext ctxt); +void bcl_ctxt_setIbase(BclContext ctxt, size_t ibase); +size_t bcl_ctxt_obase(BclContext ctxt); +void bcl_ctxt_setObase(BclContext ctxt, size_t obase); + +BclError bcl_err(BclNumber n); + +BclNumber bcl_num_create(void); +void bcl_num_free(BclNumber n); + +bool bcl_num_neg(BclNumber n); +void bcl_num_setNeg(BclNumber n, bool neg); +size_t bcl_num_scale(BclNumber n); +BclError bcl_num_setScale(BclNumber n, size_t scale); +size_t bcl_num_len(BclNumber n); + +BclError bcl_copy(BclNumber d, BclNumber s); +BclNumber bcl_dup(BclNumber s); + +BclError bcl_bigdig(BclNumber n, BclBigDig *result); +BclNumber bcl_bigdig2num(BclBigDig val); + +BclNumber bcl_add(BclNumber a, BclNumber b); +BclNumber bcl_sub(BclNumber a, BclNumber b); +BclNumber bcl_mul(BclNumber a, BclNumber b); +BclNumber bcl_div(BclNumber a, BclNumber b); +BclNumber bcl_mod(BclNumber a, BclNumber b); +BclNumber bcl_pow(BclNumber a, BclNumber b); +BclNumber bcl_lshift(BclNumber a, BclNumber b); +BclNumber bcl_rshift(BclNumber a, BclNumber b); +BclNumber bcl_sqrt(BclNumber a); +BclError bcl_divmod(BclNumber a, BclNumber b, BclNumber *c, BclNumber *d); +BclNumber bcl_modexp(BclNumber a, BclNumber b, BclNumber c); + +ssize_t bcl_cmp(BclNumber a, BclNumber b); + +void bcl_zero(BclNumber n); +void bcl_one(BclNumber n); + +BclNumber bcl_parse(const char *restrict val); +char* bcl_string(BclNumber n); + +BclNumber bcl_irand(BclNumber a); +BclNumber bcl_frand(size_t places); +BclNumber bcl_ifrand(BclNumber a, size_t places); + +BclError bcl_rand_seedWithNum(BclNumber n); +BclError bcl_rand_seed(unsigned char seed[BC_SEED_SIZE]); +void bcl_rand_reseed(void); +BclNumber bcl_rand_seed2num(void); +BclRandInt bcl_rand_int(void); +BclRandInt bcl_rand_bounded(BclRandInt bound); + +#endif // BC_BCL_H diff --git a/contrib/bc/include/file.h b/contrib/bc/include/file.h index 0ba8caa80c98..6fa08b3f436c 100644 --- a/contrib/bc/include/file.h +++ b/contrib/bc/include/file.h @@ -62,6 +62,4 @@ void bc_file_printf(BcFile *restrict f, const char *fmt, ...); void bc_file_vprintf(BcFile *restrict f, const char *fmt, va_list args); void bc_file_puts(BcFile *restrict f, const char *str); -void bc_file_ultoa(unsigned long long val, char buf[BC_FILE_ULL_LENGTH]); - #endif // BC_FILE_H diff --git a/contrib/bc/include/lex.h b/contrib/bc/include/lex.h index 68b72a7f59bb..ff9592b6e928 100644 --- a/contrib/bc/include/lex.h +++ b/contrib/bc/include/lex.h @@ -43,8 +43,8 @@ #include <vector.h> #include <lang.h> -#define bc_lex_err(l, e) (bc_vm_error((e), (l)->line)) -#define bc_lex_verr(l, e, ...) (bc_vm_error((e), (l)->line, __VA_ARGS__)) +#define bc_lex_err(l, e) (bc_vm_handleError((e), (l)->line)) +#define bc_lex_verr(l, e, ...) (bc_vm_handleError((e), (l)->line, __VA_ARGS__)) #if BC_ENABLED diff --git a/contrib/bc/include/library.h b/contrib/bc/include/library.h new file mode 100644 index 000000000000..17c3f572caee --- /dev/null +++ b/contrib/bc/include/library.h @@ -0,0 +1,165 @@ +/* + * ***************************************************************************** + * + * SPDX-License-Identifier: BSD-2-Clause + * + * Copyright (c) 2018-2020 Gavin D. Howard and contributors. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * * Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + * ***************************************************************************** + * + * The private header for the bc library. + * + */ + +#ifndef LIBBC_PRIVATE_H +#define LIBBC_PRIVATE_H + +#include <bcl.h> + +#include <num.h> + +#define BC_FUNC_HEADER_LOCK(l) \ + do { \ + BC_SIG_LOCK; \ + BC_SETJMP_LOCKED(l); \ + vm.err = BCL_ERROR_NONE; \ + vm.running = 1; \ + } while (0) + +#define BC_FUNC_FOOTER_UNLOCK(e) \ + do { \ + BC_SIG_ASSERT_LOCKED; \ + e = vm.err; \ + vm.running = 0; \ + BC_UNSETJMP; \ + BC_LONGJMP_STOP; \ + vm.sig_lock = 0; \ + } while (0) + +#define BC_FUNC_HEADER(l) \ + do { \ + BC_SETJMP(l); \ + vm.err = BCL_ERROR_NONE; \ + vm.running = 1; \ + } while (0) + +#define BC_FUNC_HEADER_INIT(l) \ + do { \ + BC_SETJMP_LOCKED(l); \ + vm.err = BCL_ERROR_NONE; \ + vm.running = 1; \ + } while (0) + +#define BC_FUNC_FOOTER_NO_ERR \ + do { \ + vm.running = 0; \ + BC_UNSETJMP; \ + BC_LONGJMP_STOP; \ + vm.sig_lock = 0; \ + } while (0) + +#define BC_FUNC_FOOTER(e) \ + do { \ + e = vm.err; \ + BC_FUNC_FOOTER_NO_ERR; \ + } while (0) + +#define BC_FUNC_RESETJMP(l) \ + do { \ + BC_SIG_ASSERT_LOCKED; \ + BC_UNSETJMP; \ + BC_SETJMP_LOCKED(l); \ + } while (0) + +#define BC_MAYBE_SETUP(c, e, n, idx) \ + do { \ + if (BC_ERR((e) != BCL_ERROR_NONE)) { \ + if ((n).num != NULL) bc_num_free(&(n)); \ + idx.i = 0 - (size_t) (e); \ + } \ + else idx = bcl_num_insert(c, &(n)); \ + } while (0) + +#define BC_CHECK_CTXT(c) \ + do { \ + c = bcl_context(); \ + if (BC_ERR(c == NULL)) { \ + BclNumber n_num; \ + n_num.i = 0 - (size_t) BCL_ERROR_INVALID_CONTEXT; \ + return n_num; \ + } \ + } while (0) + +#define BC_CHECK_CTXT_ERR(c) \ + do { \ + c = bcl_context(); \ + if (BC_ERR(c == NULL)) { \ + return BCL_ERROR_INVALID_CONTEXT; \ + } \ + } while (0) + +#define BC_CHECK_CTXT_ASSERT(c) \ + do { \ + c = bcl_context(); \ + assert(c != NULL); \ + } while (0) + +#define BC_CHECK_NUM(c, n) \ + do { \ + if (BC_ERR((n).i >= (c)->nums.len)) { \ + if ((n).i > 0 - (size_t) BCL_ERROR_NELEMS) return (n); \ + else { \ + BclNumber n_num; \ + n_num.i = 0 - (size_t) BCL_ERROR_INVALID_NUM; \ + return n_num; \ + } \ + } \ + } while (0) + +#define BC_CHECK_NUM_ERR(c, n) \ + do { \ + if (BC_ERR((n).i >= (c)->nums.len)) { \ + if ((n).i > 0 - (size_t) BCL_ERROR_NELEMS) \ + return (BclError) (0 - (n).i); \ + else return BCL_ERROR_INVALID_NUM; \ + } \ + } while (0) + +#define BC_NUM(c, n) ((BcNum*) bc_vec_item(&(c)->nums, (n).i)) + +typedef size_t (*BcReqOp)(const BcNum*, const BcNum*, size_t); + +typedef struct BclCtxt { + + size_t scale; + size_t ibase; + size_t obase; + + BcVec nums; + BcVec free_nums; + +} BclCtxt; + +#endif // LIBBC_PRIVATE_H diff --git a/contrib/bc/include/num.h b/contrib/bc/include/num.h index 239daf908834..4868ae3de6a8 100644 --- a/contrib/bc/include/num.h +++ b/contrib/bc/include/num.h @@ -45,6 +45,7 @@ #include <status.h> #include <vector.h> +#include <bcl.h> #ifndef BC_ENABLE_EXTRA_MATH #define BC_ENABLE_EXTRA_MATH (1) @@ -54,25 +55,10 @@ typedef unsigned long ulong; -// For some reason, LONG_BIT is not defined in some versions of gcc. -// I define it here to the minimum accepted value in the POSIX standard. -#ifndef LONG_BIT -#define LONG_BIT (32) -#endif // LONG_BIT - -#ifndef BC_LONG_BIT -#define BC_LONG_BIT LONG_BIT -#endif // BC_LONG_BIT - -#if BC_LONG_BIT > LONG_BIT -#error BC_LONG_BIT cannot be greater than LONG_BIT -#endif // BC_LONG_BIT > LONG_BIT +typedef BclBigDig BcBigDig; #if BC_LONG_BIT >= 64 -typedef int_least32_t BcDig; -typedef uint64_t BcBigDig; - #define BC_NUM_BIGDIG_MAX ((BcBigDig) UINT64_MAX) #define BC_BASE_DIGS (9) @@ -80,10 +66,9 @@ typedef uint64_t BcBigDig; #define BC_NUM_BIGDIG_C UINT64_C -#elif BC_LONG_BIT >= 32 +typedef int_least32_t BcDig; -typedef int_least16_t BcDig; -typedef uint32_t BcBigDig; +#elif BC_LONG_BIT >= 32 #define BC_NUM_BIGDIG_MAX ((BcBigDig) UINT32_MAX) @@ -92,6 +77,8 @@ typedef uint32_t BcBigDig; #define BC_NUM_BIGDIG_C UINT32_C +typedef int_least16_t BcDig; + #else #error BC_LONG_BIT must be at least 32 @@ -106,7 +93,6 @@ typedef struct BcNum { size_t scale; size_t len; size_t cap; - bool neg; } BcNum; #if BC_ENABLE_EXTRA_MATH @@ -150,6 +136,30 @@ struct BcRNG; #define BC_NUM_ROUND_POW(s) (bc_vm_growSize((s), BC_BASE_DIGS - 1)) #define BC_NUM_RDX(s) (BC_NUM_ROUND_POW(s) / BC_BASE_DIGS) +#define BC_NUM_RDX_VAL(n) ((n)->rdx >> 1) +#define BC_NUM_RDX_VAL_NP(n) ((n).rdx >> 1) +#define BC_NUM_RDX_SET(n, v) \ + ((n)->rdx = (((v) << 1) | ((n)->rdx & (BcBigDig) 1))) +#define BC_NUM_RDX_SET_NP(n, v) \ + ((n).rdx = (((v) << 1) | ((n).rdx & (BcBigDig) 1))) +#define BC_NUM_RDX_SET_NEG(n, v, neg) \ + ((n)->rdx = (((v) << 1) | (neg))) + +#define BC_NUM_RDX_VALID(n) \ + (BC_NUM_ZERO(n) || BC_NUM_RDX_VAL(n) * BC_BASE_DIGS >= (n)->scale) +#define BC_NUM_RDX_VALID_NP(n) \ + ((!(n).len) || BC_NUM_RDX_VAL_NP(n) * BC_BASE_DIGS >= (n).scale) + +#define BC_NUM_NEG(n) ((n)->rdx & ((BcBigDig) 1)) +#define BC_NUM_NEG_NP(n) ((n).rdx & ((BcBigDig) 1)) +#define BC_NUM_NEG_CLR(n) ((n)->rdx &= ~((BcBigDig) 1)) +#define BC_NUM_NEG_CLR_NP(n) ((n).rdx &= ~((BcBigDig) 1)) +#define BC_NUM_NEG_SET(n) ((n)->rdx |= ((BcBigDig) 1)) +#define BC_NUM_NEG_TGL(n) ((n)->rdx ^= ((BcBigDig) 1)) +#define BC_NUM_NEG_TGL_NP(n) ((n).rdx ^= ((BcBigDig) 1)) +#define BC_NUM_NEG_VAL(n, v) (((n)->rdx & ~((BcBigDig) 1)) | (v)) +#define BC_NUM_NEG_VAL_NP(n, v) (((n).rdx & ~((BcBigDig) 1)) | (v)) + #define BC_NUM_SIZE(n) ((n) * sizeof(BcDig)) #if BC_DEBUG_CODE @@ -183,7 +193,7 @@ void bc_num_bigdig2num(BcNum *restrict n, BcBigDig val); #if BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND void bc_num_irand(const BcNum *restrict a, BcNum *restrict b, - struct BcRNG *restrict rng); + struct BcRNG *restrict rng); void bc_num_rng(const BcNum *restrict n, struct BcRNG *rng); void bc_num_createFromRNG(BcNum *restrict n, struct BcRNG *rng); #endif // BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND @@ -200,28 +210,34 @@ void bc_num_lshift(BcNum *a, BcNum *b, BcNum *c, size_t scale); void bc_num_rshift(BcNum *a, BcNum *b, BcNum *c, size_t scale); #endif // BC_ENABLE_EXTRA_MATH void bc_num_sqrt(BcNum *restrict a, BcNum *restrict b, size_t scale); +void bc_num_sr(BcNum *restrict a, BcNum *restrict b, size_t scale); void bc_num_divmod(BcNum *a, BcNum *b, BcNum *c, BcNum *d, size_t scale); size_t bc_num_addReq(const BcNum* a, const BcNum* b, size_t scale); size_t bc_num_mulReq(const BcNum *a, const BcNum *b, size_t scale); +size_t bc_num_divReq(const BcNum *a, const BcNum *b, size_t scale); size_t bc_num_powReq(const BcNum *a, const BcNum *b, size_t scale); #if BC_ENABLE_EXTRA_MATH size_t bc_num_placesReq(const BcNum *a, const BcNum *b, size_t scale); #endif // BC_ENABLE_EXTRA_MATH void bc_num_truncate(BcNum *restrict n, size_t places); +void bc_num_extend(BcNum *restrict n, size_t places); +void bc_num_shiftRight(BcNum *restrict n, size_t places); + ssize_t bc_num_cmp(const BcNum *a, const BcNum *b); #if DC_ENABLED void bc_num_modexp(BcNum *a, BcNum *b, BcNum *c, BcNum *restrict d); #endif // DC_ENABLED +void bc_num_zero(BcNum *restrict n); void bc_num_one(BcNum *restrict n); ssize_t bc_num_cmpZero(const BcNum *n); -void bc_num_parse(BcNum *restrict n, const char *restrict val, - BcBigDig base, bool letter); +bool bc_num_strValid(const char *restrict val); +void bc_num_parse(BcNum *restrict n, const char *restrict val, BcBigDig base); void bc_num_print(BcNum *restrict n, BcBigDig base, bool newline); #if DC_ENABLED void bc_num_stream(BcNum *restrict n, BcBigDig base); @@ -238,6 +254,8 @@ extern const char bc_num_hex_digits[]; extern const BcBigDig bc_num_pow10[BC_BASE_DIGS + 1]; extern const BcDig bc_num_bigdigMax[]; +extern const BcDig bc_num_bigdigMax2[]; extern const size_t bc_num_bigdigMax_size; +extern const size_t bc_num_bigdigMax2_size; #endif // BC_NUM_H diff --git a/contrib/bc/include/parse.h b/contrib/bc/include/parse.h index a568fab13e64..7f59885346dc 100644 --- a/contrib/bc/include/parse.h +++ b/contrib/bc/include/parse.h @@ -62,8 +62,9 @@ #define bc_parse_push(p, i) (bc_vec_pushByte(&(p)->func->code, (uchar) (i))) #define bc_parse_pushIndex(p, idx) (bc_vec_pushIndex(&(p)->func->code, (idx))) -#define bc_parse_err(p, e) (bc_vm_error((e), (p)->l.line)) -#define bc_parse_verr(p, e, ...) (bc_vm_error((e), (p)->l.line, __VA_ARGS__)) +#define bc_parse_err(p, e) (bc_vm_handleError((e), (p)->l.line)) +#define bc_parse_verr(p, e, ...) \ + (bc_vm_handleError((e), (p)->l.line, __VA_ARGS__)) typedef struct BcParseNext { uchar len; @@ -110,7 +111,7 @@ void bc_parse_updateFunc(BcParse *p, size_t fidx); void bc_parse_pushName(const BcParse* p, char *name, bool var); void bc_parse_text(BcParse *p, const char *text); -extern const char bc_parse_zero[]; -extern const char bc_parse_one[]; +extern const char bc_parse_zero[2]; +extern const char bc_parse_one[2]; #endif // BC_PARSE_H diff --git a/contrib/bc/include/rand.h b/contrib/bc/include/rand.h index 3c8aafd62ade..a2fb713803ee 100644 --- a/contrib/bc/include/rand.h +++ b/contrib/bc/include/rand.h @@ -223,6 +223,7 @@ void bc_rand_seed(BcRNG *r, ulong state1, ulong state2, ulong inc1, ulong inc2); void bc_rand_push(BcRNG *r); void bc_rand_pop(BcRNG *r, bool reset); void bc_rand_getRands(BcRNG *r, BcRand *s1, BcRand *s2, BcRand *i1, BcRand *i2); +void bc_rand_srand(BcRNGData *rng); extern const BcRandState bc_rand_multiplier; diff --git a/contrib/bc/include/status.h b/contrib/bc/include/status.h index 279edfef8710..762ff3e25c36 100644 --- a/contrib/bc/include/status.h +++ b/contrib/bc/include/status.h @@ -46,6 +46,8 @@ #define DC_ENABLED (1) #endif // DC_ENABLED +#include <bcl.h> + typedef enum BcStatus { BC_STATUS_SUCCESS = 0, @@ -58,75 +60,75 @@ typedef enum BcStatus { } BcStatus; -typedef enum BcError { - - BC_ERROR_MATH_NEGATIVE, - BC_ERROR_MATH_NON_INTEGER, - BC_ERROR_MATH_OVERFLOW, - BC_ERROR_MATH_DIVIDE_BY_ZERO, - - BC_ERROR_FATAL_ALLOC_ERR, - BC_ERROR_FATAL_IO_ERR, - BC_ERROR_FATAL_FILE_ERR, - BC_ERROR_FATAL_BIN_FILE, - BC_ERROR_FATAL_PATH_DIR, - BC_ERROR_FATAL_OPTION, - BC_ERROR_FATAL_OPTION_NO_ARG, - BC_ERROR_FATAL_OPTION_ARG, - - BC_ERROR_EXEC_IBASE, - BC_ERROR_EXEC_OBASE, - BC_ERROR_EXEC_SCALE, - BC_ERROR_EXEC_READ_EXPR, - BC_ERROR_EXEC_REC_READ, - BC_ERROR_EXEC_TYPE, - - BC_ERROR_EXEC_STACK, - - BC_ERROR_EXEC_PARAMS, - BC_ERROR_EXEC_UNDEF_FUNC, - BC_ERROR_EXEC_VOID_VAL, - - BC_ERROR_PARSE_EOF, - BC_ERROR_PARSE_CHAR, - BC_ERROR_PARSE_STRING, - BC_ERROR_PARSE_COMMENT, - BC_ERROR_PARSE_TOKEN, +typedef enum BcErr { + + BC_ERR_MATH_NEGATIVE, + BC_ERR_MATH_NON_INTEGER, + BC_ERR_MATH_OVERFLOW, + BC_ERR_MATH_DIVIDE_BY_ZERO, + + BC_ERR_FATAL_ALLOC_ERR, + BC_ERR_FATAL_IO_ERR, + BC_ERR_FATAL_FILE_ERR, + BC_ERR_FATAL_BIN_FILE, + BC_ERR_FATAL_PATH_DIR, + BC_ERR_FATAL_OPTION, + BC_ERR_FATAL_OPTION_NO_ARG, + BC_ERR_FATAL_OPTION_ARG, + + BC_ERR_EXEC_IBASE, + BC_ERR_EXEC_OBASE, + BC_ERR_EXEC_SCALE, + BC_ERR_EXEC_READ_EXPR, + BC_ERR_EXEC_REC_READ, + BC_ERR_EXEC_TYPE, + + BC_ERR_EXEC_STACK, + + BC_ERR_EXEC_PARAMS, + BC_ERR_EXEC_UNDEF_FUNC, + BC_ERR_EXEC_VOID_VAL, + + BC_ERR_PARSE_EOF, + BC_ERR_PARSE_CHAR, + BC_ERR_PARSE_STRING, + BC_ERR_PARSE_COMMENT, + BC_ERR_PARSE_TOKEN, #if BC_ENABLED - BC_ERROR_PARSE_EXPR, - BC_ERROR_PARSE_EMPTY_EXPR, - BC_ERROR_PARSE_PRINT, - BC_ERROR_PARSE_FUNC, - BC_ERROR_PARSE_ASSIGN, - BC_ERROR_PARSE_NO_AUTO, - BC_ERROR_PARSE_DUP_LOCAL, - BC_ERROR_PARSE_BLOCK, - BC_ERROR_PARSE_RET_VOID, - BC_ERROR_PARSE_REF_VAR, - - BC_ERROR_POSIX_NAME_LEN, - BC_ERROR_POSIX_COMMENT, - BC_ERROR_POSIX_KW, - BC_ERROR_POSIX_DOT, - BC_ERROR_POSIX_RET, - BC_ERROR_POSIX_BOOL, - BC_ERROR_POSIX_REL_POS, - BC_ERROR_POSIX_MULTIREL, - BC_ERROR_POSIX_FOR, - BC_ERROR_POSIX_EXP_NUM, - BC_ERROR_POSIX_REF, - BC_ERROR_POSIX_VOID, - BC_ERROR_POSIX_BRACE, + BC_ERR_PARSE_EXPR, + BC_ERR_PARSE_EMPTY_EXPR, + BC_ERR_PARSE_PRINT, + BC_ERR_PARSE_FUNC, + BC_ERR_PARSE_ASSIGN, + BC_ERR_PARSE_NO_AUTO, + BC_ERR_PARSE_DUP_LOCAL, + BC_ERR_PARSE_BLOCK, + BC_ERR_PARSE_RET_VOID, + BC_ERR_PARSE_REF_VAR, + + BC_ERR_POSIX_NAME_LEN, + BC_ERR_POSIX_COMMENT, + BC_ERR_POSIX_KW, + BC_ERR_POSIX_DOT, + BC_ERR_POSIX_RET, + BC_ERR_POSIX_BOOL, + BC_ERR_POSIX_REL_POS, + BC_ERR_POSIX_MULTIREL, + BC_ERR_POSIX_FOR, + BC_ERR_POSIX_EXP_NUM, + BC_ERR_POSIX_REF, + BC_ERR_POSIX_VOID, + BC_ERR_POSIX_BRACE, #endif // BC_ENABLED - BC_ERROR_NELEMS, + BC_ERR_NELEMS, #if BC_ENABLED - BC_ERROR_POSIX_START = BC_ERROR_POSIX_NAME_LEN, - BC_ERROR_POSIX_END = BC_ERROR_POSIX_BRACE, + BC_ERR_POSIX_START = BC_ERR_POSIX_NAME_LEN, + BC_ERR_POSIX_END = BC_ERR_POSIX_BRACE, #endif // BC_ENABLED -} BcError; +} BcErr; #define BC_ERR_IDX_MATH (0) #define BC_ERR_IDX_PARSE (1) @@ -163,6 +165,12 @@ typedef enum BcError { #define BC_MUST_RETURN #endif // __STDC_VERSION__ +#if defined(__clang__) || defined(__GNUC__) +#define BC_FALLTHROUGH __attribute__((fallthrough)); +#else // defined(__clang__) || defined(__GNUC__) +#define BC_FALLTHROUGH +#endif //defined(__clang__) || defined(__GNUC__) + // Workarounds for AIX's POSIX incompatibility. #ifndef SIZE_MAX #define SIZE_MAX __SIZE_MAX__ diff --git a/contrib/bc/include/vector.h b/contrib/bc/include/vector.h index bad178eede30..fdfb85d58228 100644 --- a/contrib/bc/include/vector.h +++ b/contrib/bc/include/vector.h @@ -62,6 +62,7 @@ typedef struct BcVec { void bc_vec_init(BcVec *restrict v, size_t esize, BcVecFree dtor); void bc_vec_expand(BcVec *restrict v, size_t req); +void bc_vec_grow(BcVec *restrict v, size_t n); void bc_vec_npop(BcVec *restrict v, size_t n); void bc_vec_npopAt(BcVec *restrict v, size_t n, size_t idx); diff --git a/contrib/bc/include/vm.h b/contrib/bc/include/vm.h index f178c0390853..72a5150266a1 100644 --- a/contrib/bc/include/vm.h +++ b/contrib/bc/include/vm.h @@ -36,6 +36,7 @@ #ifndef BC_VM_H #define BC_VM_H +#include <assert.h> #include <stddef.h> #include <limits.h> @@ -56,7 +57,10 @@ #include <parse.h> #include <program.h> #include <history.h> + +#if !BC_ENABLE_LIBRARY #include <file.h> +#endif // !BC_ENABLE_LIBRARY #if !BC_ENABLED && !DC_ENABLED #error Must define BC_ENABLED, DC_ENABLED, or both @@ -91,6 +95,8 @@ #define isatty _isatty #endif // _WIN32 +#if !BC_ENABLE_LIBRARY + #if DC_ENABLED #define DC_FLAG_X (UINTMAX_C(1)<<0) #endif // DC_ENABLED @@ -149,6 +155,8 @@ #define BC_USE_PROMPT (!BC_P && BC_TTY) #endif // BC_ENABLED +#endif // !BC_ENABLE_LIBRARY + #define BC_MAX(a, b) ((a) > (b) ? (a) : (b)) #define BC_MIN(a, b) ((a) < (b) ? (a) : (b)) @@ -270,31 +278,75 @@ #define BC_VM_SAFE_RESULT(r) ((r)->t >= BC_RESULT_TEMP) -#define bc_vm_err(e) (bc_vm_error((e), 0)) -#define bc_vm_verr(e, ...) (bc_vm_error((e), 0, __VA_ARGS__)) +#if BC_ENABLE_LIBRARY +#define bc_vm_error(e, l, ...) (bc_vm_handleError((e))) +#define bc_vm_err(e) (bc_vm_handleError((e))) +#define bc_vm_verr(e, ...) (bc_vm_handleError((e))) +#else // BC_ENABLE_LIBRARY +#define bc_vm_error(e, l, ...) (bc_vm_handleError((e), (l), __VA_ARGS__)) +#define bc_vm_err(e) (bc_vm_handleError((e), 0)) +#define bc_vm_verr(e, ...) (bc_vm_handleError((e), 0, __VA_ARGS__)) +#endif // BC_ENABLE_LIBRARY #define BC_STATUS_IS_ERROR(s) \ ((s) >= BC_STATUS_ERROR_MATH && (s) <= BC_STATUS_ERROR_FATAL) #define BC_VM_INVALID_CATALOG ((nl_catd) -1) +#if BC_DEBUG_CODE +#define BC_VM_FUNC_ENTER \ + do { \ + bc_file_printf(&vm.ferr, "Entering %s\n", __func__); \ + bc_file_flush(&vm.ferr); \ + } while (0); + +#define BC_VM_FUNC_EXIT \ + do { \ + bc_file_printf(&vm.ferr, "Leaving %s\n", __func__); \ + bc_file_flush(&vm.ferr); \ + } while (0); +#else // BC_DEBUG_CODE +#define BC_VM_FUNC_ENTER +#define BC_VM_FUNC_EXIT +#endif // BC_DEBUG_CODE + typedef struct BcVm { volatile sig_atomic_t status; volatile sig_atomic_t sig_pop; +#if !BC_ENABLE_LIBRARY BcParse prs; BcProgram prog; +#endif // BC_ENABLE_LIBRARY BcVec jmp_bufs; BcVec temps; +#if BC_ENABLE_LIBRARY + + BcVec ctxts; + BcVec out; + + BcRNG rng; + + BclError err; + bool abrt; + + unsigned int refs; + + volatile sig_atomic_t running; +#endif // BC_ENABLE_LIBRARY + +#if !BC_ENABLE_LIBRARY const char* file; const char *sigmsg; +#endif // BC_ENABLE_LIBRARY volatile sig_atomic_t sig_lock; volatile sig_atomic_t sig; +#if !BC_ENABLE_LIBRARY uchar siglen; uchar read_ret; @@ -305,9 +357,11 @@ typedef struct BcVm { bool no_exit_exprs; bool eof; +#endif // BC_ENABLE_LIBRARY BcBigDig maxes[BC_PROG_GLOBALS_LEN + BC_ENABLE_EXTRA_MATH]; +#if !BC_ENABLE_LIBRARY BcVec files; BcVec exprs; @@ -325,21 +379,27 @@ typedef struct BcVm { const char *func_header; const char *err_ids[BC_ERR_IDX_NELEMS + BC_ENABLED]; - const char *err_msgs[BC_ERROR_NELEMS]; + const char *err_msgs[BC_ERR_NELEMS]; const char *locale; +#endif // BC_ENABLE_LIBRARY BcBigDig last_base; BcBigDig last_pow; BcBigDig last_exp; BcBigDig last_rem; +#if !BC_ENABLE_LIBRARY char *env_args_buffer; BcVec env_args; +#endif // BC_ENABLE_LIBRARY BcNum max; + BcNum max2; BcDig max_num[BC_NUM_BIGDIG_LOG10]; + BcDig max2_num[BC_NUM_BIGDIG_LOG10]; +#if !BC_ENABLE_LIBRARY BcFile fout; BcFile ferr; @@ -349,13 +409,16 @@ typedef struct BcVm { char *buf; size_t buf_len; +#endif // !BC_ENABLE_LIBRARY } BcVm; void bc_vm_info(const char* const help); void bc_vm_boot(int argc, char *argv[], const char *env_len, const char* const env_args); +void bc_vm_init(void); void bc_vm_shutdown(void); +void bc_vm_freeTemps(void); void bc_vm_printf(const char *fmt, ...); void bc_vm_putchar(int c); @@ -371,7 +434,11 @@ void bc_vm_jmp(const char *f); void bc_vm_jmp(void); #endif // BC_DEBUG_CODE -void bc_vm_error(BcError e, size_t line, ...); +#if BC_ENABLE_LIBRARY +void bc_vm_handleError(BcErr e); +#else // BC_ENABLE_LIBRARY +void bc_vm_handleError(BcErr e, size_t line, ...); +#endif // BC_ENABLE_LIBRARY extern const char bc_copyright[]; extern const char* const bc_err_line; diff --git a/contrib/bc/manpage.sh b/contrib/bc/manpage.sh index 631d162d51c3..edde671da238 100755 --- a/contrib/bc/manpage.sh +++ b/contrib/bc/manpage.sh @@ -32,6 +32,21 @@ usage() { exit 1 } +print_manpage() { + + _print_manpage_md="$1" + shift + + _print_manpage_out="$1" + shift + + cat "$manualsdir/header.txt" > "$_print_manpage_out" + cat "$manualsdir/header_${manpage}.txt" >> "$_print_manpage_out" + + pandoc -f markdown -t man "$_print_manpage_md" >> "$_print_manpage_out" + +} + gen_manpage() { _gen_manpage_args="$1" @@ -84,10 +99,7 @@ gen_manpage() { IFS="$_gen_manpage_ifs" - cat "$manualsdir/header.txt" > "$_gen_manpage_out" - cat "$manualsdir/header_${manpage}.txt" >> "$_gen_manpage_out" - - pandoc -f markdown -t man "$_gen_manpage_md" >> "$_gen_manpage_out" + print_manpage "$_gen_manpage_md" "$_gen_manpage_out" } set -e @@ -108,6 +120,12 @@ test "$#" -eq 1 || usage manpage="$1" shift -for a in $ARGS; do - gen_manpage "$a" -done +if [ "$manpage" != "bcl" ]; then + + for a in $ARGS; do + gen_manpage "$a" + done + +else + print_manpage "$manualsdir/${manpage}.3.md" "$manualsdir/${manpage}.3" +fi diff --git a/contrib/bc/manuals/bc.1.md.in b/contrib/bc/manuals/bc.1.md.in index 80892e742345..efc0be037526 100644 --- a/contrib/bc/manuals/bc.1.md.in +++ b/contrib/bc/manuals/bc.1.md.in @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -477,9 +477,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that {{ A H N P HN HP NP HNP }} In addition, bc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. @@ -652,7 +652,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -1019,6 +1019,8 @@ The extended library is a **non-portable extension**. : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. + It is an error if **y** is negative and **x** is **0**. + This is a transcendental function (see the *Transcendental Functions* subsection below). @@ -1798,7 +1800,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/A.1 b/contrib/bc/manuals/bc/A.1 index f0966ba9d877..2e2816290587 100644 --- a/contrib/bc/manuals/bc/A.1 +++ b/contrib/bc/manuals/bc/A.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,13 +46,13 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .PP -This bc(1) is a drop\-in replacement for \f[I]any\f[] bc(1), including +This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. @@ -58,9 +60,9 @@ implementations. .PP The following are the options that bc(1) accepts. .TP -.B \f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] -Turns the globals \f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], and -\f[B]seed\f[] into stacks. +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] +Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and +\f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are @@ -68,40 +70,40 @@ pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. -Thus, a hypothetical function named \f[B]output(x,b)\f[] that simply -printed \f[B]x\f[] in base \f[B]b\f[] could be written like this: +Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply +printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ obase=b -\ \ \ \ x +define void output(x, b) { + obase=b + x } -\f[] +\f[R] .fi .PP instead of like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ auto\ c -\ \ \ \ c=obase -\ \ \ \ obase=b -\ \ \ \ x -\ \ \ \ obase=c +define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c } -\f[] +\f[R] .fi .PP This makes writing functions much easier. .PP -(\f[B]Note\f[]: the function \f[B]output(x,b)\f[] exists in the extended -math library. -See the \f[B]LIBRARY\f[] section.) +(\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the +extended math library. +See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set -\f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] +\f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP @@ -112,118 +114,115 @@ Examples: .IP .nf \f[C] -alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" -\f[] +alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] +alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] +\f[R] .fi .PP -Second, if the purpose of a function is to set \f[B]ibase\f[], -\f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] globally for any other -purpose, it could be split into one to four functions (based on how many -globals it sets) and each of those functions could return the desired -value for a global. -.PP -For functions that set \f[B]seed\f[], the value assigned to -\f[B]seed\f[] is not propagated to parent functions. -This means that the sequence of pseudo\-random numbers that they see -will not be the same sequence of pseudo\-random numbers that any parent -sees. -This is only the case once \f[B]seed\f[] has been set. -.PP -If a function desires to not affect the sequence of pseudo\-random -numbers of its parents, but wants to use the same \f[B]seed\f[], it can +Second, if the purpose of a function is to set \f[B]ibase\f[R], +\f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any +other purpose, it could be split into one to four functions (based on +how many globals it sets) and each of those functions could return the +desired value for a global. +.PP +For functions that set \f[B]seed\f[R], the value assigned to +\f[B]seed\f[R] is not propagated to parent functions. +This means that the sequence of pseudo-random numbers that they see will +not be the same sequence of pseudo-random numbers that any parent sees. +This is only the case once \f[B]seed\f[R] has been set. +.PP +If a function desires to not affect the sequence of pseudo-random +numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] -seed\ =\ seed -\f[] +seed = seed +\f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then -users could make sure to define \f[B]BC_ENV_ARGS\f[] and include this -option (see the \f[B]ENVIRONMENT VARIABLES\f[] section for more +users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this +option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP -If \f[B]\-s\f[], \f[B]\-w\f[], or any equivalents are used, this option +If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library and the extended math library before +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP -To learn what is in the libraries, see the \f[B]LIBRARY\f[] section. +To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in -\f[B]BC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT VARIABLES\f[] section). +\f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -232,61 +231,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -294,388 +293,392 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]seed\f[] +\f[B]seed\f[R] .IP "7." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Numbers 6 and 7 are \f[B]non\-portable extensions\f[]. +Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP -The \f[I]scale\f[] and sign of the value may be significant. -.PP -If a previously used \f[B]seed\f[] value is assigned to \f[B]seed\f[] -and used again, the pseudo\-random number generator is guaranteed to -produce the same sequence of pseudo\-random numbers as it did when the -\f[B]seed\f[] value was previously used. -.PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if \f[B]seed\f[] is queried again immediately. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will -\f[I]not\f[] produce unique sequences of pseudo\-random numbers. -The value of \f[B]seed\f[] will change after any use of the -\f[B]rand()\f[] and \f[B]irand(E)\f[] operands (see the -\f[I]Operands\f[] subsection below), except if the parameter passed to -\f[B]irand(E)\f[] is \f[B]0\f[], \f[B]1\f[], or negative. +The \f[I]scale\f[R] and sign of the value may be significant. +.PP +If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] +and used again, the pseudo-random number generator is guaranteed to +produce the same sequence of pseudo-random numbers as it did when the +\f[B]seed\f[R] value was previously used. +.PP +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if \f[B]seed\f[R] is queried again immediately. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will +\f[I]not\f[R] produce unique sequences of pseudo-random numbers. +The value of \f[B]seed\f[R] will change after any use of the +\f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the +\f[I]Operands\f[R] subsection below), except if the parameter passed to +\f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "14." 4 -\f[B]rand()\f[]: A pseudo\-random integer between \f[B]0\f[] (inclusive) -and \f[B]BC_RAND_MAX\f[] (inclusive). -Using this operand will change the value of \f[B]seed\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). +Using this operand will change the value of \f[B]seed\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "15." 4 -\f[B]irand(E)\f[]: A pseudo\-random integer between \f[B]0\f[] -(inclusive) and the value of \f[B]E\f[] (exclusive). -If \f[B]E\f[] is negative or is a non\-integer (\f[B]E\f[]\[aq]s -\f[I]scale\f[] is not \f[B]0\f[]), an error is raised, and bc(1) resets -(see the \f[B]RESET\f[] section) while \f[B]seed\f[] remains unchanged. -If \f[B]E\f[] is larger than \f[B]BC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]BC_RAND_MAX+1\f[], and adding them +\f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and the value of \f[B]E\f[R] (exclusive). +If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s +\f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) +resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains +unchanged. +If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. -Using this operand will change the value of \f[B]seed\f[], unless the -value of \f[B]E\f[] is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is returned, and \f[B]seed\f[] is \f[I]not\f[] -changed. -This is a \f[B]non\-portable extension\f[]. +Using this operand will change the value of \f[B]seed\f[R], unless the +value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is +\f[I]not\f[R] changed. +This is a \f[B]non-portable extension\f[R]. .IP "16." 4 -\f[B]maxrand()\f[]: The max integer returned by \f[B]rand()\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. +This is a \f[B]non-portable extension\f[R]. .PP -The integers generated by \f[B]rand()\f[] and \f[B]irand(E)\f[] are +The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of -the pseudo\-random number generator. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with \f[B]rand()\f[] and \f[B]irand(E)\f[] are guaranteed to -\f[I]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[I]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. +the pseudo-random number generator. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to +\f[I]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[I]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e\-3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -Using scientific notation is an error or warning if the \f[B]\-s\f[] or -\f[B]\-w\f[], respectively, command\-line options (or equivalents) are +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +Using scientific notation is an error or warning if the \f[B]-s\f[R] or +\f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and bc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if bc(1) is given the number string -\f[B]10e\-4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if bc(1) is given the number string +\f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP -Description: \f[B]truncation\f[] +Description: \f[B]truncation\f[R] .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]set precision\f[] +Description: \f[B]set precision\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]<<\f[] \f[B]>>\f[] +\f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]shift left\f[], \f[B]shift right\f[] +Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -683,270 +686,264 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] -The \f[B]truncation\f[] operator returns a copy of the given expression -with all of its \f[I]scale\f[] removed. +\f[B]$\f[R] +The \f[B]truncation\f[R] operator returns a copy of the given expression +with all of its \f[I]scale\f[R] removed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] -The \f[B]set precision\f[] operator takes two expressions and returns a -copy of the first with its \f[I]scale\f[] equal to the value of the +\f[B]\[at]\f[R] +The \f[B]set precision\f[R] operator takes two expressions and returns a +copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if -the \f[I]scale\f[] of the first expression matches the value of the +the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE -.TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. +.TP +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]<<\f[] -The \f[B]left shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the right. +\f[B]<<\f[R] +The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the right. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]>>\f[] -The \f[B]right shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the left. +\f[B]>>\f[R] +The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the left. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .PP -The \f[B]assignment\f[] operators that correspond to operators that are -extensions are themselves \f[B]non\-portable extensions\f[]. +The \f[B]assignment\f[R] operators that correspond to operators that are +extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[], and engineering notation is activated by assigning -\f[B]1\f[] to \f[B]obase\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R], and engineering notation is activated by assigning +\f[B]1\f[R] to \f[B]obase\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is -run with either the \f[B]\-s\f[] or \f[B]\-w\f[] command\-line options +run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -956,152 +953,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -1110,23 +1107,23 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math -library (see the \f[I]Extended Library\f[] subsection below), are -available when the \f[B]\-l\f[] or \f[B]\-\-mathlib\f[] command\-line +library (see the \f[I]Extended Library\f[R] subsection below), are +available when the \f[B]-l\f[R] or \f[B]\[en]mathlib\f[R] command-line flags are given, except that the extended math library is not available -when the \f[B]\-s\f[] option, the \f[B]\-w\f[] option, or equivalents +when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP @@ -1134,545 +1131,528 @@ The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Extended Library .PP -The extended library is \f[I]not\f[] loaded when the -\f[B]\-s\f[]/\f[B]\-\-standard\f[] or \f[B]\-w\f[]/\f[B]\-\-warn\f[] +The extended library is \f[I]not\f[R] loaded when the +\f[B]-s\f[R]/\f[B]\[en]standard\f[R] or \f[B]-w\f[R]/\f[B]\[en]warn\f[R] options are given since they are not part of the library defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html). .PP -The extended library is a \f[B]non\-portable extension\f[]. +The extended library is a \f[B]non-portable extension\f[R]. .TP -.B \f[B]p(x, y)\f[] -Calculates \f[B]x\f[] to the power of \f[B]y\f[], even if \f[B]y\f[] is -not an integer, and returns the result to the current \f[B]scale\f[]. +\f[B]p(x, y)\f[R] +Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] +is not an integer, and returns the result to the current +\f[B]scale\f[R]. .RS .PP +It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is +\f[B]0\f[R]. +.PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round half away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). -.RS -.RE +\f[B]r(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round half away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP -.B \f[B]ceil(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). -.RS -.RE +\f[B]ceil(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP -.B \f[B]f(x)\f[] -Returns the factorial of the truncated absolute value of \f[B]x\f[]. -.RS -.RE +\f[B]f(x)\f[R] +Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]perm(n, k)\f[] -Returns the permutation of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]perm(n, k)\f[R] +Returns the permutation of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]comb(n, k)\f[] -Returns the combination of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]comb(n, k)\f[R] +Returns the combination of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]l2(x)\f[] -Returns the logarithm base \f[B]2\f[] of \f[B]x\f[]. +\f[B]l2(x)\f[R] +Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l10(x)\f[] -Returns the logarithm base \f[B]10\f[] of \f[B]x\f[]. +\f[B]l10(x)\f[R] +Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]log(x, b)\f[] -Returns the logarithm base \f[B]b\f[] of \f[B]x\f[]. +\f[B]log(x, b)\f[R] +Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cbrt(x)\f[] -Returns the cube root of \f[B]x\f[]. -.RS -.RE +\f[B]cbrt(x)\f[R] +Returns the cube root of \f[B]x\f[R]. .TP -.B \f[B]root(x, n)\f[] -Calculates the truncated value of \f[B]n\f[], \f[B]r\f[], and returns -the \f[B]r\f[]th root of \f[B]x\f[] to the current \f[B]scale\f[]. +\f[B]root(x, n)\f[R] +Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns +the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP -If \f[B]r\f[] is \f[B]0\f[] or negative, this raises an error and causes -bc(1) to reset (see the \f[B]RESET\f[] section). -It also raises an error and causes bc(1) to reset if \f[B]r\f[] is even -and \f[B]x\f[] is negative. +If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and +causes bc(1) to reset (see the \f[B]RESET\f[R] section). +It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even +and \f[B]x\f[R] is negative. .RE .TP -.B \f[B]pi(p)\f[] -Returns \f[B]pi\f[] to \f[B]p\f[] decimal places. +\f[B]pi(p)\f[R] +Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]t(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]t(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]a2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]a2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]sin(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]sin(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]s(x)\f[]. +This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cos(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]cos(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]c(x)\f[]. +This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]tan(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]tan(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -If \f[B]x\f[] is equal to \f[B]1\f[] or \f[B]\-1\f[], this raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an +error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP -This is an alias of \f[B]t(x)\f[]. +This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]atan(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]atan(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP -This is an alias of \f[B]a(x)\f[]. +This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]atan2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]atan2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP -This is an alias of \f[B]a2(y, x)\f[]. +This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r2d(x)\f[] -Converts \f[B]x\f[] from radians to degrees and returns the result. +\f[B]r2d(x)\f[R] +Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]d2r(x)\f[] -Converts \f[B]x\f[] from degrees to radians and returns the result. +\f[B]d2r(x)\f[R] +Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]frand(p)\f[] -Generates a pseudo\-random number between \f[B]0\f[] (inclusive) and -\f[B]1\f[] (exclusive) with the number of decimal digits after the -decimal point equal to the truncated absolute value of \f[B]p\f[]. -If \f[B]p\f[] is not \f[B]0\f[], then calling this function will change -the value of \f[B]seed\f[]. -If \f[B]p\f[] is \f[B]0\f[], then \f[B]0\f[] is returned, and -\f[B]seed\f[] is \f[I]not\f[] changed. -.RS -.RE +\f[B]frand(p)\f[R] +Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and +\f[B]1\f[R] (exclusive) with the number of decimal digits after the +decimal point equal to the truncated absolute value of \f[B]p\f[R]. +If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will +change the value of \f[B]seed\f[R]. +If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and +\f[B]seed\f[R] is \f[I]not\f[R] changed. .TP -.B \f[B]ifrand(i, p)\f[] -Generates a pseudo\-random number that is between \f[B]0\f[] (inclusive) -and the truncated absolute value of \f[B]i\f[] (exclusive) with the +\f[B]ifrand(i, p)\f[R] +Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) +and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated -absolute value of \f[B]p\f[]. -If the absolute value of \f[B]i\f[] is greater than or equal to -\f[B]2\f[], and \f[B]p\f[] is not \f[B]0\f[], then calling this function -will change the value of \f[B]seed\f[]; otherwise, \f[B]0\f[] is -returned and \f[B]seed\f[] is not changed. -.RS -.RE +absolute value of \f[B]p\f[R]. +If the absolute value of \f[B]i\f[R] is greater than or equal to +\f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this +function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] +is returned and \f[B]seed\f[R] is not changed. .TP -.B \f[B]srand(x)\f[] -Returns \f[B]x\f[] with its sign flipped with probability \f[B]0.5\f[]. -In other words, it randomizes the sign of \f[B]x\f[]. -.RS -.RE +\f[B]srand(x)\f[R] +Returns \f[B]x\f[R] with its sign flipped with probability +\f[B]0.5\f[R]. +In other words, it randomizes the sign of \f[B]x\f[R]. .TP -.B \f[B]brand()\f[] -Returns a random boolean value (either \f[B]0\f[] or \f[B]1\f[]). -.RS -.RE +\f[B]brand()\f[R] +Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP -.B \f[B]ubytes(x)\f[] +\f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the -truncated absolute value of \f[B]x\f[]. -.RS -.RE +truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]sbytes(x)\f[] -Returns the numbers of signed, two\[aq]s\-complement integer bytes -required to hold the truncated value of \f[B]x\f[]. -.RS -.RE +\f[B]sbytes(x)\f[R] +Returns the numbers of signed, two\[cq]s-complement integer bytes +required to hold the truncated value of \f[B]x\f[R]. .TP -.B \f[B]hex(x)\f[] -Outputs the hexadecimal (base \f[B]16\f[]) representation of \f[B]x\f[]. +\f[B]hex(x)\f[R] +Outputs the hexadecimal (base \f[B]16\f[R]) representation of +\f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary(x)\f[] -Outputs the binary (base \f[B]2\f[]) representation of \f[B]x\f[]. +\f[B]binary(x)\f[R] +Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output(x, b)\f[] -Outputs the base \f[B]b\f[] representation of \f[B]x\f[]. +\f[B]output(x, b)\f[R] +Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as +\f[B]uint(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or is negative, an error message is -printed instead, but bc(1) is not reset (see the \f[B]RESET\f[] +If \f[B]x\f[R] is not an integer or is negative, an error message is +printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in as few power of two bytes as +\f[B]int(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, an error message is printed instead, -but bc(1) is not reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, an error message is printed instead, +but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uintn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]n\f[] bytes. +\f[B]uintn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]n\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]intn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]n\f[] bytes. +\f[B]intn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]n\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]1\f[] byte. +\f[B]uint8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]1\f[] byte, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]1\f[] byte. +\f[B]int8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]1\f[] byte, an +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]2\f[] bytes. +\f[B]uint16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]2\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]2\f[] bytes. +\f[B]int16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]2\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]4\f[] bytes. +\f[B]uint32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]4\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]4\f[] bytes. +\f[B]int32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]4\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]8\f[] bytes. +\f[B]uint64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]8\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]8\f[] bytes. +\f[B]int64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]8\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]hex_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in hexadecimal using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]hex_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] +bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in binary using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]binary_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in the current \f[B]obase\f[] (see the -\f[B]SYNTAX\f[] section) using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]output_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see +the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_byte(x, i)\f[] -Outputs byte \f[B]i\f[] of the truncated absolute value of \f[B]x\f[], -where \f[B]0\f[] is the least significant byte and \f[B]number_of_bytes -\- 1\f[] is the most significant byte. +\f[B]output_byte(x, i)\f[R] +Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], +where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes +- 1\f[R] is the most significant byte. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP @@ -1684,55 +1664,55 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 -\f[B]l2(x)\f[] +\f[B]l2(x)\f[R] .IP \[bu] 2 -\f[B]l10(x)\f[] +\f[B]l10(x)\f[R] .IP \[bu] 2 -\f[B]log(x, b)\f[] +\f[B]log(x, b)\f[R] .IP \[bu] 2 -\f[B]pi(p)\f[] +\f[B]pi(p)\f[R] .IP \[bu] 2 -\f[B]t(x)\f[] +\f[B]t(x)\f[R] .IP \[bu] 2 -\f[B]a2(y, x)\f[] +\f[B]a2(y, x)\f[R] .IP \[bu] 2 -\f[B]sin(x)\f[] +\f[B]sin(x)\f[R] .IP \[bu] 2 -\f[B]cos(x)\f[] +\f[B]cos(x)\f[R] .IP \[bu] 2 -\f[B]tan(x)\f[] +\f[B]tan(x)\f[R] .IP \[bu] 2 -\f[B]atan(x)\f[] +\f[B]atan(x)\f[R] .IP \[bu] 2 -\f[B]atan2(y, x)\f[] +\f[B]atan2(y, x)\f[R] .IP \[bu] 2 -\f[B]r2d(x)\f[] +\f[B]r2d(x)\f[R] .IP \[bu] 2 -\f[B]d2r(x)\f[] +\f[B]d2r(x)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1745,7 +1725,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1753,269 +1733,238 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]rand()\f[] operand. -Set at \f[B]2^BC_LONG_BIT\-1\f[]. -.RS -.RE +\f[B]BC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]rand()\f[R] +operand. +Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]<<\f[]), and -right shift (\f[B]>>\f[]) operators and their corresponding assignment -operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their +corresponding assignment operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP The prompt is enabled in TTY mode. @@ -2023,65 +1972,65 @@ The prompt is enabled in TTY mode. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when bc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause bc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when bc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -bc(1) supports interactive command\-line editing. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +bc(1) supports interactive command-line editing. +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGES\f[]. +locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it -supports \f[B]LC_MESSAGES\f[]. +supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP None are known. @@ -2089,4 +2038,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/A.1.md b/contrib/bc/manuals/bc/A.1.md index e67c20656e23..5e5b75bb3821 100644 --- a/contrib/bc/manuals/bc/A.1.md +++ b/contrib/bc/manuals/bc/A.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -419,9 +419,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **35**. In addition, bc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. @@ -584,7 +584,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -933,6 +933,8 @@ The extended library is a **non-portable extension**. : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. + It is an error if **y** is negative and **x** is **0**. + This is a transcendental function (see the *Transcendental Functions* subsection below). @@ -1681,7 +1683,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/E.1 b/contrib/bc/manuals/bc/E.1 index d85db650606c..6bacb680af67 100644 --- a/contrib/bc/manuals/bc/E.1 +++ b/contrib/bc/manuals/bc/E.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,147 +46,145 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .PP -This bc(1) is a drop\-in replacement for \f[I]any\f[] bc(1), including +This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). .SH OPTIONS .PP The following are the options that bc(1) accepts. .PP -\f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] .IP .nf \f[C] -Turns\ the\ globals\ **ibase**,\ **obase**,\ and\ **scale**\ into\ stacks. +Turns the globals **ibase**, **obase**, and **scale** into stacks. -This\ has\ the\ effect\ that\ a\ copy\ of\ the\ current\ value\ of\ all\ three\ are\ pushed -onto\ a\ stack\ for\ every\ function\ call,\ as\ well\ as\ popped\ when\ every\ function -returns.\ This\ means\ that\ functions\ can\ assign\ to\ any\ and\ all\ of\ those -globals\ without\ worrying\ that\ the\ change\ will\ affect\ other\ functions. -Thus,\ a\ hypothetical\ function\ named\ **output(x,b)**\ that\ simply\ printed -**x**\ in\ base\ **b**\ could\ be\ written\ like\ this: +This has the effect that a copy of the current value of all three are pushed +onto a stack for every function call, as well as popped when every function +returns. This means that functions can assign to any and all of those +globals without worrying that the change will affect other functions. +Thus, a hypothetical function named **output(x,b)** that simply printed +**x** in base **b** could be written like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ } + define void output(x, b) { + obase=b + x + } -instead\ of\ like\ this: +instead of like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ auto\ c -\ \ \ \ \ \ \ \ c=obase -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ \ \ \ \ obase=c -\ \ \ \ } + define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c + } -This\ makes\ writing\ functions\ much\ easier. +This makes writing functions much easier. -However,\ since\ using\ this\ flag\ means\ that\ functions\ cannot\ set\ **ibase**, -**obase**,\ or\ **scale**\ globally,\ functions\ that\ are\ made\ to\ do\ so\ cannot -work\ anymore.\ There\ are\ two\ possible\ use\ cases\ for\ that,\ and\ each\ has\ a +However, since using this flag means that functions cannot set **ibase**, +**obase**, or **scale** globally, functions that are made to do so cannot +work anymore. There are two possible use cases for that, and each has a solution. -First,\ if\ a\ function\ is\ called\ on\ startup\ to\ turn\ bc(1)\ into\ a\ number -converter,\ it\ is\ possible\ to\ replace\ that\ capability\ with\ various\ shell -aliases.\ Examples: +First, if a function is called on startup to turn bc(1) into a number +converter, it is possible to replace that capability with various shell +aliases. Examples: -\ \ \ \ alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -\ \ \ \ alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" + alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] + alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] -Second,\ if\ the\ purpose\ of\ a\ function\ is\ to\ set\ **ibase**,\ **obase**,\ or -**scale**\ globally\ for\ any\ other\ purpose,\ it\ could\ be\ split\ into\ one\ to -three\ functions\ (based\ on\ how\ many\ globals\ it\ sets)\ and\ each\ of\ those -functions\ could\ return\ the\ desired\ value\ for\ a\ global. +Second, if the purpose of a function is to set **ibase**, **obase**, or +**scale** globally for any other purpose, it could be split into one to +three functions (based on how many globals it sets) and each of those +functions could return the desired value for a global. -If\ the\ behavior\ of\ this\ option\ is\ desired\ for\ every\ run\ of\ bc(1),\ then\ users -could\ make\ sure\ to\ define\ **BC_ENV_ARGS**\ and\ include\ this\ option\ (see\ the -**ENVIRONMENT\ VARIABLES**\ section\ for\ more\ details). +If the behavior of this option is desired for every run of bc(1), then users +could make sure to define **BC_ENV_ARGS** and include this option (see the +**ENVIRONMENT VARIABLES** section for more details). -If\ **\-s**,\ **\-w**,\ or\ any\ equivalents\ are\ used,\ this\ option\ is\ ignored. +If **-s**, **-w**, or any equivalents are used, this option is ignored. -This\ is\ a\ **non\-portable\ extension**. -\f[] +This is a **non-portable extension**. +\f[R] .fi .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library before running any code, including any -expressions or files specified on the command line. +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library before running any code, including +any expressions or files specified on the command line. .RS .PP -To learn what is in the library, see the \f[B]LIBRARY\f[] section. +To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in -\f[B]BC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT VARIABLES\f[] section). +\f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -193,61 +193,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -255,268 +255,270 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Number 6 is a \f[B]non\-portable extension\f[]. +Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -524,205 +526,199 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -732,152 +728,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -886,73 +882,73 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP -All of the functions below are available when the \f[B]\-l\f[] or -\f[B]\-\-mathlib\f[] command\-line flags are given. +All of the functions below are available when the \f[B]-l\f[R] or +\f[B]\[en]mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP @@ -964,27 +960,27 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -997,7 +993,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1005,259 +1001,230 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator and the corresponding assignment operator. +power (\f[B]\[ha]\f[R]) operator and the corresponding assignment +operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP The prompt is enabled in TTY mode. @@ -1265,65 +1232,65 @@ The prompt is enabled in TTY mode. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when bc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause bc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when bc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -bc(1) supports interactive command\-line editing. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +bc(1) supports interactive command-line editing. +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGES\f[]. +locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it -supports \f[B]LC_MESSAGES\f[]. +supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP None are known. @@ -1331,4 +1298,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/E.1.md b/contrib/bc/manuals/bc/E.1.md index ab432274fa52..3bec29912b77 100644 --- a/contrib/bc/manuals/bc/E.1.md +++ b/contrib/bc/manuals/bc/E.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -457,7 +457,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -1075,7 +1075,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/EH.1 b/contrib/bc/manuals/bc/EH.1 index c9b196f7452a..ed19e9769bd7 100644 --- a/contrib/bc/manuals/bc/EH.1 +++ b/contrib/bc/manuals/bc/EH.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,144 +46,142 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .SH OPTIONS .PP The following are the options that bc(1) accepts. .PP -\f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] .IP .nf \f[C] -Turns\ the\ globals\ **ibase**,\ **obase**,\ and\ **scale**\ into\ stacks. +Turns the globals **ibase**, **obase**, and **scale** into stacks. -This\ has\ the\ effect\ that\ a\ copy\ of\ the\ current\ value\ of\ all\ three\ are\ pushed -onto\ a\ stack\ for\ every\ function\ call,\ as\ well\ as\ popped\ when\ every\ function -returns.\ This\ means\ that\ functions\ can\ assign\ to\ any\ and\ all\ of\ those -globals\ without\ worrying\ that\ the\ change\ will\ affect\ other\ functions. -Thus,\ a\ hypothetical\ function\ named\ **output(x,b)**\ that\ simply\ printed -**x**\ in\ base\ **b**\ could\ be\ written\ like\ this: +This has the effect that a copy of the current value of all three are pushed +onto a stack for every function call, as well as popped when every function +returns. This means that functions can assign to any and all of those +globals without worrying that the change will affect other functions. +Thus, a hypothetical function named **output(x,b)** that simply printed +**x** in base **b** could be written like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ } + define void output(x, b) { + obase=b + x + } -instead\ of\ like\ this: +instead of like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ auto\ c -\ \ \ \ \ \ \ \ c=obase -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ \ \ \ \ obase=c -\ \ \ \ } + define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c + } -This\ makes\ writing\ functions\ much\ easier. +This makes writing functions much easier. -However,\ since\ using\ this\ flag\ means\ that\ functions\ cannot\ set\ **ibase**, -**obase**,\ or\ **scale**\ globally,\ functions\ that\ are\ made\ to\ do\ so\ cannot -work\ anymore.\ There\ are\ two\ possible\ use\ cases\ for\ that,\ and\ each\ has\ a +However, since using this flag means that functions cannot set **ibase**, +**obase**, or **scale** globally, functions that are made to do so cannot +work anymore. There are two possible use cases for that, and each has a solution. -First,\ if\ a\ function\ is\ called\ on\ startup\ to\ turn\ bc(1)\ into\ a\ number -converter,\ it\ is\ possible\ to\ replace\ that\ capability\ with\ various\ shell -aliases.\ Examples: +First, if a function is called on startup to turn bc(1) into a number +converter, it is possible to replace that capability with various shell +aliases. Examples: -\ \ \ \ alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -\ \ \ \ alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" + alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] + alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] -Second,\ if\ the\ purpose\ of\ a\ function\ is\ to\ set\ **ibase**,\ **obase**,\ or -**scale**\ globally\ for\ any\ other\ purpose,\ it\ could\ be\ split\ into\ one\ to -three\ functions\ (based\ on\ how\ many\ globals\ it\ sets)\ and\ each\ of\ those -functions\ could\ return\ the\ desired\ value\ for\ a\ global. +Second, if the purpose of a function is to set **ibase**, **obase**, or +**scale** globally for any other purpose, it could be split into one to +three functions (based on how many globals it sets) and each of those +functions could return the desired value for a global. -If\ the\ behavior\ of\ this\ option\ is\ desired\ for\ every\ run\ of\ bc(1),\ then\ users -could\ make\ sure\ to\ define\ **BC_ENV_ARGS**\ and\ include\ this\ option\ (see\ the -**ENVIRONMENT\ VARIABLES**\ section\ for\ more\ details). +If the behavior of this option is desired for every run of bc(1), then users +could make sure to define **BC_ENV_ARGS** and include this option (see the +**ENVIRONMENT VARIABLES** section for more details). -If\ **\-s**,\ **\-w**,\ or\ any\ equivalents\ are\ used,\ this\ option\ is\ ignored. +If **-s**, **-w**, or any equivalents are used, this option is ignored. -This\ is\ a\ **non\-portable\ extension**. -\f[] +This is a **non-portable extension**. +\f[R] .fi .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library before running any code, including any -expressions or files specified on the command line. +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library before running any code, including +any expressions or files specified on the command line. .RS .PP -To learn what is in the library, see the \f[B]LIBRARY\f[] section. +To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in -\f[B]BC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT VARIABLES\f[] section). +\f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -190,61 +190,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -252,268 +252,270 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Number 6 is a \f[B]non\-portable extension\f[]. +Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -521,205 +523,199 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -729,152 +725,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -883,73 +879,73 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP -All of the functions below are available when the \f[B]\-l\f[] or -\f[B]\-\-mathlib\f[] command\-line flags are given. +All of the functions below are available when the \f[B]-l\f[R] or +\f[B]\[en]mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP @@ -961,27 +957,27 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -994,7 +990,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1002,310 +998,281 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator and the corresponding assignment operator. +power (\f[B]\[ha]\f[R]) operator and the corresponding assignment +operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP The prompt is enabled in TTY mode. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGES\f[]. +locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it -supports \f[B]LC_MESSAGES\f[]. +supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP None are known. @@ -1313,4 +1280,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/EH.1.md b/contrib/bc/manuals/bc/EH.1.md index 32ef6e0d009f..32d95f48fcee 100644 --- a/contrib/bc/manuals/bc/EH.1.md +++ b/contrib/bc/manuals/bc/EH.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -454,7 +454,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -1059,7 +1059,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/EHN.1 b/contrib/bc/manuals/bc/EHN.1 index 0117a4cd0b68..39846195d4b3 100644 --- a/contrib/bc/manuals/bc/EHN.1 +++ b/contrib/bc/manuals/bc/EHN.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,144 +46,142 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .SH OPTIONS .PP The following are the options that bc(1) accepts. .PP -\f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] .IP .nf \f[C] -Turns\ the\ globals\ **ibase**,\ **obase**,\ and\ **scale**\ into\ stacks. +Turns the globals **ibase**, **obase**, and **scale** into stacks. -This\ has\ the\ effect\ that\ a\ copy\ of\ the\ current\ value\ of\ all\ three\ are\ pushed -onto\ a\ stack\ for\ every\ function\ call,\ as\ well\ as\ popped\ when\ every\ function -returns.\ This\ means\ that\ functions\ can\ assign\ to\ any\ and\ all\ of\ those -globals\ without\ worrying\ that\ the\ change\ will\ affect\ other\ functions. -Thus,\ a\ hypothetical\ function\ named\ **output(x,b)**\ that\ simply\ printed -**x**\ in\ base\ **b**\ could\ be\ written\ like\ this: +This has the effect that a copy of the current value of all three are pushed +onto a stack for every function call, as well as popped when every function +returns. This means that functions can assign to any and all of those +globals without worrying that the change will affect other functions. +Thus, a hypothetical function named **output(x,b)** that simply printed +**x** in base **b** could be written like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ } + define void output(x, b) { + obase=b + x + } -instead\ of\ like\ this: +instead of like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ auto\ c -\ \ \ \ \ \ \ \ c=obase -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ \ \ \ \ obase=c -\ \ \ \ } + define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c + } -This\ makes\ writing\ functions\ much\ easier. +This makes writing functions much easier. -However,\ since\ using\ this\ flag\ means\ that\ functions\ cannot\ set\ **ibase**, -**obase**,\ or\ **scale**\ globally,\ functions\ that\ are\ made\ to\ do\ so\ cannot -work\ anymore.\ There\ are\ two\ possible\ use\ cases\ for\ that,\ and\ each\ has\ a +However, since using this flag means that functions cannot set **ibase**, +**obase**, or **scale** globally, functions that are made to do so cannot +work anymore. There are two possible use cases for that, and each has a solution. -First,\ if\ a\ function\ is\ called\ on\ startup\ to\ turn\ bc(1)\ into\ a\ number -converter,\ it\ is\ possible\ to\ replace\ that\ capability\ with\ various\ shell -aliases.\ Examples: +First, if a function is called on startup to turn bc(1) into a number +converter, it is possible to replace that capability with various shell +aliases. Examples: -\ \ \ \ alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -\ \ \ \ alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" + alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] + alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] -Second,\ if\ the\ purpose\ of\ a\ function\ is\ to\ set\ **ibase**,\ **obase**,\ or -**scale**\ globally\ for\ any\ other\ purpose,\ it\ could\ be\ split\ into\ one\ to -three\ functions\ (based\ on\ how\ many\ globals\ it\ sets)\ and\ each\ of\ those -functions\ could\ return\ the\ desired\ value\ for\ a\ global. +Second, if the purpose of a function is to set **ibase**, **obase**, or +**scale** globally for any other purpose, it could be split into one to +three functions (based on how many globals it sets) and each of those +functions could return the desired value for a global. -If\ the\ behavior\ of\ this\ option\ is\ desired\ for\ every\ run\ of\ bc(1),\ then\ users -could\ make\ sure\ to\ define\ **BC_ENV_ARGS**\ and\ include\ this\ option\ (see\ the -**ENVIRONMENT\ VARIABLES**\ section\ for\ more\ details). +If the behavior of this option is desired for every run of bc(1), then users +could make sure to define **BC_ENV_ARGS** and include this option (see the +**ENVIRONMENT VARIABLES** section for more details). -If\ **\-s**,\ **\-w**,\ or\ any\ equivalents\ are\ used,\ this\ option\ is\ ignored. +If **-s**, **-w**, or any equivalents are used, this option is ignored. -This\ is\ a\ **non\-portable\ extension**. -\f[] +This is a **non-portable extension**. +\f[R] .fi .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library before running any code, including any -expressions or files specified on the command line. +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library before running any code, including +any expressions or files specified on the command line. .RS .PP -To learn what is in the library, see the \f[B]LIBRARY\f[] section. +To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in -\f[B]BC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT VARIABLES\f[] section). +\f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -190,61 +190,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -252,268 +252,270 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Number 6 is a \f[B]non\-portable extension\f[]. +Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -521,205 +523,199 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -729,152 +725,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -883,73 +879,73 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP -All of the functions below are available when the \f[B]\-l\f[] or -\f[B]\-\-mathlib\f[] command\-line flags are given. +All of the functions below are available when the \f[B]-l\f[R] or +\f[B]\[en]mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP @@ -961,27 +957,27 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -994,7 +990,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1002,303 +998,274 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator and the corresponding assignment operator. +power (\f[B]\[ha]\f[R]) operator and the corresponding assignment +operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP The prompt is enabled in TTY mode. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP None are known. @@ -1306,4 +1273,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/EHN.1.md b/contrib/bc/manuals/bc/EHN.1.md index 38b7cf78d76a..2eaf8145c90e 100644 --- a/contrib/bc/manuals/bc/EHN.1.md +++ b/contrib/bc/manuals/bc/EHN.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -454,7 +454,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -1051,7 +1051,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/EHNP.1 b/contrib/bc/manuals/bc/EHNP.1 index 02b96492075d..231dc1d404c4 100644 --- a/contrib/bc/manuals/bc/EHNP.1 +++ b/contrib/bc/manuals/bc/EHNP.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,139 +46,137 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .SH OPTIONS .PP The following are the options that bc(1) accepts. .PP -\f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] .IP .nf \f[C] -Turns\ the\ globals\ **ibase**,\ **obase**,\ and\ **scale**\ into\ stacks. +Turns the globals **ibase**, **obase**, and **scale** into stacks. -This\ has\ the\ effect\ that\ a\ copy\ of\ the\ current\ value\ of\ all\ three\ are\ pushed -onto\ a\ stack\ for\ every\ function\ call,\ as\ well\ as\ popped\ when\ every\ function -returns.\ This\ means\ that\ functions\ can\ assign\ to\ any\ and\ all\ of\ those -globals\ without\ worrying\ that\ the\ change\ will\ affect\ other\ functions. -Thus,\ a\ hypothetical\ function\ named\ **output(x,b)**\ that\ simply\ printed -**x**\ in\ base\ **b**\ could\ be\ written\ like\ this: +This has the effect that a copy of the current value of all three are pushed +onto a stack for every function call, as well as popped when every function +returns. This means that functions can assign to any and all of those +globals without worrying that the change will affect other functions. +Thus, a hypothetical function named **output(x,b)** that simply printed +**x** in base **b** could be written like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ } + define void output(x, b) { + obase=b + x + } -instead\ of\ like\ this: +instead of like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ auto\ c -\ \ \ \ \ \ \ \ c=obase -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ \ \ \ \ obase=c -\ \ \ \ } + define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c + } -This\ makes\ writing\ functions\ much\ easier. +This makes writing functions much easier. -However,\ since\ using\ this\ flag\ means\ that\ functions\ cannot\ set\ **ibase**, -**obase**,\ or\ **scale**\ globally,\ functions\ that\ are\ made\ to\ do\ so\ cannot -work\ anymore.\ There\ are\ two\ possible\ use\ cases\ for\ that,\ and\ each\ has\ a +However, since using this flag means that functions cannot set **ibase**, +**obase**, or **scale** globally, functions that are made to do so cannot +work anymore. There are two possible use cases for that, and each has a solution. -First,\ if\ a\ function\ is\ called\ on\ startup\ to\ turn\ bc(1)\ into\ a\ number -converter,\ it\ is\ possible\ to\ replace\ that\ capability\ with\ various\ shell -aliases.\ Examples: +First, if a function is called on startup to turn bc(1) into a number +converter, it is possible to replace that capability with various shell +aliases. Examples: -\ \ \ \ alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -\ \ \ \ alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" + alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] + alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] -Second,\ if\ the\ purpose\ of\ a\ function\ is\ to\ set\ **ibase**,\ **obase**,\ or -**scale**\ globally\ for\ any\ other\ purpose,\ it\ could\ be\ split\ into\ one\ to -three\ functions\ (based\ on\ how\ many\ globals\ it\ sets)\ and\ each\ of\ those -functions\ could\ return\ the\ desired\ value\ for\ a\ global. +Second, if the purpose of a function is to set **ibase**, **obase**, or +**scale** globally for any other purpose, it could be split into one to +three functions (based on how many globals it sets) and each of those +functions could return the desired value for a global. -If\ the\ behavior\ of\ this\ option\ is\ desired\ for\ every\ run\ of\ bc(1),\ then\ users -could\ make\ sure\ to\ define\ **BC_ENV_ARGS**\ and\ include\ this\ option\ (see\ the -**ENVIRONMENT\ VARIABLES**\ section\ for\ more\ details). +If the behavior of this option is desired for every run of bc(1), then users +could make sure to define **BC_ENV_ARGS** and include this option (see the +**ENVIRONMENT VARIABLES** section for more details). -If\ **\-s**,\ **\-w**,\ or\ any\ equivalents\ are\ used,\ this\ option\ is\ ignored. +If **-s**, **-w**, or any equivalents are used, this option is ignored. -This\ is\ a\ **non\-portable\ extension**. -\f[] +This is a **non-portable extension**. +\f[R] .fi .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library before running any code, including any -expressions or files specified on the command line. +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library before running any code, including +any expressions or files specified on the command line. .RS .PP -To learn what is in the library, see the \f[B]LIBRARY\f[] section. +To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -185,61 +185,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -247,268 +247,270 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Number 6 is a \f[B]non\-portable extension\f[]. +Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -516,205 +518,199 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -724,152 +720,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -878,73 +874,73 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP -All of the functions below are available when the \f[B]\-l\f[] or -\f[B]\-\-mathlib\f[] command\-line flags are given. +All of the functions below are available when the \f[B]-l\f[R] or +\f[B]\[en]mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP @@ -956,27 +952,27 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -989,7 +985,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -997,301 +993,272 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator and the corresponding assignment operator. +power (\f[B]\[ha]\f[R]) operator and the corresponding assignment +operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP None are known. @@ -1299,4 +1266,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/EHNP.1.md b/contrib/bc/manuals/bc/EHNP.1.md index df608db015b4..4138ffb98c5e 100644 --- a/contrib/bc/manuals/bc/EHNP.1.md +++ b/contrib/bc/manuals/bc/EHNP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -450,7 +450,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -1045,7 +1045,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/EHP.1 b/contrib/bc/manuals/bc/EHP.1 index cc2920f84403..7dcc83b7bddd 100644 --- a/contrib/bc/manuals/bc/EHP.1 +++ b/contrib/bc/manuals/bc/EHP.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,139 +46,137 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .SH OPTIONS .PP The following are the options that bc(1) accepts. .PP -\f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] .IP .nf \f[C] -Turns\ the\ globals\ **ibase**,\ **obase**,\ and\ **scale**\ into\ stacks. +Turns the globals **ibase**, **obase**, and **scale** into stacks. -This\ has\ the\ effect\ that\ a\ copy\ of\ the\ current\ value\ of\ all\ three\ are\ pushed -onto\ a\ stack\ for\ every\ function\ call,\ as\ well\ as\ popped\ when\ every\ function -returns.\ This\ means\ that\ functions\ can\ assign\ to\ any\ and\ all\ of\ those -globals\ without\ worrying\ that\ the\ change\ will\ affect\ other\ functions. -Thus,\ a\ hypothetical\ function\ named\ **output(x,b)**\ that\ simply\ printed -**x**\ in\ base\ **b**\ could\ be\ written\ like\ this: +This has the effect that a copy of the current value of all three are pushed +onto a stack for every function call, as well as popped when every function +returns. This means that functions can assign to any and all of those +globals without worrying that the change will affect other functions. +Thus, a hypothetical function named **output(x,b)** that simply printed +**x** in base **b** could be written like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ } + define void output(x, b) { + obase=b + x + } -instead\ of\ like\ this: +instead of like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ auto\ c -\ \ \ \ \ \ \ \ c=obase -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ \ \ \ \ obase=c -\ \ \ \ } + define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c + } -This\ makes\ writing\ functions\ much\ easier. +This makes writing functions much easier. -However,\ since\ using\ this\ flag\ means\ that\ functions\ cannot\ set\ **ibase**, -**obase**,\ or\ **scale**\ globally,\ functions\ that\ are\ made\ to\ do\ so\ cannot -work\ anymore.\ There\ are\ two\ possible\ use\ cases\ for\ that,\ and\ each\ has\ a +However, since using this flag means that functions cannot set **ibase**, +**obase**, or **scale** globally, functions that are made to do so cannot +work anymore. There are two possible use cases for that, and each has a solution. -First,\ if\ a\ function\ is\ called\ on\ startup\ to\ turn\ bc(1)\ into\ a\ number -converter,\ it\ is\ possible\ to\ replace\ that\ capability\ with\ various\ shell -aliases.\ Examples: +First, if a function is called on startup to turn bc(1) into a number +converter, it is possible to replace that capability with various shell +aliases. Examples: -\ \ \ \ alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -\ \ \ \ alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" + alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] + alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] -Second,\ if\ the\ purpose\ of\ a\ function\ is\ to\ set\ **ibase**,\ **obase**,\ or -**scale**\ globally\ for\ any\ other\ purpose,\ it\ could\ be\ split\ into\ one\ to -three\ functions\ (based\ on\ how\ many\ globals\ it\ sets)\ and\ each\ of\ those -functions\ could\ return\ the\ desired\ value\ for\ a\ global. +Second, if the purpose of a function is to set **ibase**, **obase**, or +**scale** globally for any other purpose, it could be split into one to +three functions (based on how many globals it sets) and each of those +functions could return the desired value for a global. -If\ the\ behavior\ of\ this\ option\ is\ desired\ for\ every\ run\ of\ bc(1),\ then\ users -could\ make\ sure\ to\ define\ **BC_ENV_ARGS**\ and\ include\ this\ option\ (see\ the -**ENVIRONMENT\ VARIABLES**\ section\ for\ more\ details). +If the behavior of this option is desired for every run of bc(1), then users +could make sure to define **BC_ENV_ARGS** and include this option (see the +**ENVIRONMENT VARIABLES** section for more details). -If\ **\-s**,\ **\-w**,\ or\ any\ equivalents\ are\ used,\ this\ option\ is\ ignored. +If **-s**, **-w**, or any equivalents are used, this option is ignored. -This\ is\ a\ **non\-portable\ extension**. -\f[] +This is a **non-portable extension**. +\f[R] .fi .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library before running any code, including any -expressions or files specified on the command line. +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library before running any code, including +any expressions or files specified on the command line. .RS .PP -To learn what is in the library, see the \f[B]LIBRARY\f[] section. +To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -185,61 +185,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -247,268 +247,270 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Number 6 is a \f[B]non\-portable extension\f[]. +Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -516,205 +518,199 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -724,152 +720,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -878,73 +874,73 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP -All of the functions below are available when the \f[B]\-l\f[] or -\f[B]\-\-mathlib\f[] command\-line flags are given. +All of the functions below are available when the \f[B]-l\f[R] or +\f[B]\[en]mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP @@ -956,27 +952,27 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -989,7 +985,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -997,308 +993,279 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator and the corresponding assignment operator. +power (\f[B]\[ha]\f[R]) operator and the corresponding assignment +operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGES\f[]. +locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it -supports \f[B]LC_MESSAGES\f[]. +supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP None are known. @@ -1306,4 +1273,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/EHP.1.md b/contrib/bc/manuals/bc/EHP.1.md index 0ce1f5209c21..c012f68fed43 100644 --- a/contrib/bc/manuals/bc/EHP.1.md +++ b/contrib/bc/manuals/bc/EHP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -450,7 +450,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -1053,7 +1053,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/EN.1 b/contrib/bc/manuals/bc/EN.1 index d7f967d96cd5..d11c6f7742a1 100644 --- a/contrib/bc/manuals/bc/EN.1 +++ b/contrib/bc/manuals/bc/EN.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,147 +46,145 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .PP -This bc(1) is a drop\-in replacement for \f[I]any\f[] bc(1), including +This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). .SH OPTIONS .PP The following are the options that bc(1) accepts. .PP -\f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] .IP .nf \f[C] -Turns\ the\ globals\ **ibase**,\ **obase**,\ and\ **scale**\ into\ stacks. +Turns the globals **ibase**, **obase**, and **scale** into stacks. -This\ has\ the\ effect\ that\ a\ copy\ of\ the\ current\ value\ of\ all\ three\ are\ pushed -onto\ a\ stack\ for\ every\ function\ call,\ as\ well\ as\ popped\ when\ every\ function -returns.\ This\ means\ that\ functions\ can\ assign\ to\ any\ and\ all\ of\ those -globals\ without\ worrying\ that\ the\ change\ will\ affect\ other\ functions. -Thus,\ a\ hypothetical\ function\ named\ **output(x,b)**\ that\ simply\ printed -**x**\ in\ base\ **b**\ could\ be\ written\ like\ this: +This has the effect that a copy of the current value of all three are pushed +onto a stack for every function call, as well as popped when every function +returns. This means that functions can assign to any and all of those +globals without worrying that the change will affect other functions. +Thus, a hypothetical function named **output(x,b)** that simply printed +**x** in base **b** could be written like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ } + define void output(x, b) { + obase=b + x + } -instead\ of\ like\ this: +instead of like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ auto\ c -\ \ \ \ \ \ \ \ c=obase -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ \ \ \ \ obase=c -\ \ \ \ } + define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c + } -This\ makes\ writing\ functions\ much\ easier. +This makes writing functions much easier. -However,\ since\ using\ this\ flag\ means\ that\ functions\ cannot\ set\ **ibase**, -**obase**,\ or\ **scale**\ globally,\ functions\ that\ are\ made\ to\ do\ so\ cannot -work\ anymore.\ There\ are\ two\ possible\ use\ cases\ for\ that,\ and\ each\ has\ a +However, since using this flag means that functions cannot set **ibase**, +**obase**, or **scale** globally, functions that are made to do so cannot +work anymore. There are two possible use cases for that, and each has a solution. -First,\ if\ a\ function\ is\ called\ on\ startup\ to\ turn\ bc(1)\ into\ a\ number -converter,\ it\ is\ possible\ to\ replace\ that\ capability\ with\ various\ shell -aliases.\ Examples: +First, if a function is called on startup to turn bc(1) into a number +converter, it is possible to replace that capability with various shell +aliases. Examples: -\ \ \ \ alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -\ \ \ \ alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" + alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] + alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] -Second,\ if\ the\ purpose\ of\ a\ function\ is\ to\ set\ **ibase**,\ **obase**,\ or -**scale**\ globally\ for\ any\ other\ purpose,\ it\ could\ be\ split\ into\ one\ to -three\ functions\ (based\ on\ how\ many\ globals\ it\ sets)\ and\ each\ of\ those -functions\ could\ return\ the\ desired\ value\ for\ a\ global. +Second, if the purpose of a function is to set **ibase**, **obase**, or +**scale** globally for any other purpose, it could be split into one to +three functions (based on how many globals it sets) and each of those +functions could return the desired value for a global. -If\ the\ behavior\ of\ this\ option\ is\ desired\ for\ every\ run\ of\ bc(1),\ then\ users -could\ make\ sure\ to\ define\ **BC_ENV_ARGS**\ and\ include\ this\ option\ (see\ the -**ENVIRONMENT\ VARIABLES**\ section\ for\ more\ details). +If the behavior of this option is desired for every run of bc(1), then users +could make sure to define **BC_ENV_ARGS** and include this option (see the +**ENVIRONMENT VARIABLES** section for more details). -If\ **\-s**,\ **\-w**,\ or\ any\ equivalents\ are\ used,\ this\ option\ is\ ignored. +If **-s**, **-w**, or any equivalents are used, this option is ignored. -This\ is\ a\ **non\-portable\ extension**. -\f[] +This is a **non-portable extension**. +\f[R] .fi .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library before running any code, including any -expressions or files specified on the command line. +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library before running any code, including +any expressions or files specified on the command line. .RS .PP -To learn what is in the library, see the \f[B]LIBRARY\f[] section. +To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in -\f[B]BC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT VARIABLES\f[] section). +\f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -193,61 +193,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -255,268 +255,270 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Number 6 is a \f[B]non\-portable extension\f[]. +Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -524,205 +526,199 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -732,152 +728,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -886,73 +882,73 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP -All of the functions below are available when the \f[B]\-l\f[] or -\f[B]\-\-mathlib\f[] command\-line flags are given. +All of the functions below are available when the \f[B]-l\f[R] or +\f[B]\[en]mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP @@ -964,27 +960,27 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -997,7 +993,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1005,259 +1001,230 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator and the corresponding assignment operator. +power (\f[B]\[ha]\f[R]) operator and the corresponding assignment +operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP The prompt is enabled in TTY mode. @@ -1265,58 +1232,58 @@ The prompt is enabled in TTY mode. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when bc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause bc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when bc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -bc(1) supports interactive command\-line editing. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +bc(1) supports interactive command-line editing. +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP None are known. @@ -1324,4 +1291,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/EN.1.md b/contrib/bc/manuals/bc/EN.1.md index 55ca344ddeb2..e7ba17a98401 100644 --- a/contrib/bc/manuals/bc/EN.1.md +++ b/contrib/bc/manuals/bc/EN.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -457,7 +457,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -1067,7 +1067,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/ENP.1 b/contrib/bc/manuals/bc/ENP.1 index 736e26bd9acd..0240b22b495a 100644 --- a/contrib/bc/manuals/bc/ENP.1 +++ b/contrib/bc/manuals/bc/ENP.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,142 +46,140 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .PP -This bc(1) is a drop\-in replacement for \f[I]any\f[] bc(1), including +This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). .SH OPTIONS .PP The following are the options that bc(1) accepts. .PP -\f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] .IP .nf \f[C] -Turns\ the\ globals\ **ibase**,\ **obase**,\ and\ **scale**\ into\ stacks. +Turns the globals **ibase**, **obase**, and **scale** into stacks. -This\ has\ the\ effect\ that\ a\ copy\ of\ the\ current\ value\ of\ all\ three\ are\ pushed -onto\ a\ stack\ for\ every\ function\ call,\ as\ well\ as\ popped\ when\ every\ function -returns.\ This\ means\ that\ functions\ can\ assign\ to\ any\ and\ all\ of\ those -globals\ without\ worrying\ that\ the\ change\ will\ affect\ other\ functions. -Thus,\ a\ hypothetical\ function\ named\ **output(x,b)**\ that\ simply\ printed -**x**\ in\ base\ **b**\ could\ be\ written\ like\ this: +This has the effect that a copy of the current value of all three are pushed +onto a stack for every function call, as well as popped when every function +returns. This means that functions can assign to any and all of those +globals without worrying that the change will affect other functions. +Thus, a hypothetical function named **output(x,b)** that simply printed +**x** in base **b** could be written like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ } + define void output(x, b) { + obase=b + x + } -instead\ of\ like\ this: +instead of like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ auto\ c -\ \ \ \ \ \ \ \ c=obase -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ \ \ \ \ obase=c -\ \ \ \ } + define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c + } -This\ makes\ writing\ functions\ much\ easier. +This makes writing functions much easier. -However,\ since\ using\ this\ flag\ means\ that\ functions\ cannot\ set\ **ibase**, -**obase**,\ or\ **scale**\ globally,\ functions\ that\ are\ made\ to\ do\ so\ cannot -work\ anymore.\ There\ are\ two\ possible\ use\ cases\ for\ that,\ and\ each\ has\ a +However, since using this flag means that functions cannot set **ibase**, +**obase**, or **scale** globally, functions that are made to do so cannot +work anymore. There are two possible use cases for that, and each has a solution. -First,\ if\ a\ function\ is\ called\ on\ startup\ to\ turn\ bc(1)\ into\ a\ number -converter,\ it\ is\ possible\ to\ replace\ that\ capability\ with\ various\ shell -aliases.\ Examples: +First, if a function is called on startup to turn bc(1) into a number +converter, it is possible to replace that capability with various shell +aliases. Examples: -\ \ \ \ alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -\ \ \ \ alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" + alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] + alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] -Second,\ if\ the\ purpose\ of\ a\ function\ is\ to\ set\ **ibase**,\ **obase**,\ or -**scale**\ globally\ for\ any\ other\ purpose,\ it\ could\ be\ split\ into\ one\ to -three\ functions\ (based\ on\ how\ many\ globals\ it\ sets)\ and\ each\ of\ those -functions\ could\ return\ the\ desired\ value\ for\ a\ global. +Second, if the purpose of a function is to set **ibase**, **obase**, or +**scale** globally for any other purpose, it could be split into one to +three functions (based on how many globals it sets) and each of those +functions could return the desired value for a global. -If\ the\ behavior\ of\ this\ option\ is\ desired\ for\ every\ run\ of\ bc(1),\ then\ users -could\ make\ sure\ to\ define\ **BC_ENV_ARGS**\ and\ include\ this\ option\ (see\ the -**ENVIRONMENT\ VARIABLES**\ section\ for\ more\ details). +If the behavior of this option is desired for every run of bc(1), then users +could make sure to define **BC_ENV_ARGS** and include this option (see the +**ENVIRONMENT VARIABLES** section for more details). -If\ **\-s**,\ **\-w**,\ or\ any\ equivalents\ are\ used,\ this\ option\ is\ ignored. +If **-s**, **-w**, or any equivalents are used, this option is ignored. -This\ is\ a\ **non\-portable\ extension**. -\f[] +This is a **non-portable extension**. +\f[R] .fi .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library before running any code, including any -expressions or files specified on the command line. +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library before running any code, including +any expressions or files specified on the command line. .RS .PP -To learn what is in the library, see the \f[B]LIBRARY\f[] section. +To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -188,61 +188,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -250,268 +250,270 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Number 6 is a \f[B]non\-portable extension\f[]. +Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -519,205 +521,199 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -727,152 +723,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -881,73 +877,73 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP -All of the functions below are available when the \f[B]\-l\f[] or -\f[B]\-\-mathlib\f[] command\-line flags are given. +All of the functions below are available when the \f[B]-l\f[R] or +\f[B]\[en]mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP @@ -959,27 +955,27 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -992,7 +988,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1000,316 +996,287 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator and the corresponding assignment operator. +power (\f[B]\[ha]\f[R]) operator and the corresponding assignment +operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when bc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause bc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when bc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -bc(1) supports interactive command\-line editing. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +bc(1) supports interactive command-line editing. +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP None are known. @@ -1317,4 +1284,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/ENP.1.md b/contrib/bc/manuals/bc/ENP.1.md index 1eae3dee00d1..8e5b6fbdd27c 100644 --- a/contrib/bc/manuals/bc/ENP.1.md +++ b/contrib/bc/manuals/bc/ENP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -453,7 +453,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -1061,7 +1061,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/EP.1 b/contrib/bc/manuals/bc/EP.1 index 107342a54361..01f34378fd65 100644 --- a/contrib/bc/manuals/bc/EP.1 +++ b/contrib/bc/manuals/bc/EP.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,142 +46,140 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .PP -This bc(1) is a drop\-in replacement for \f[I]any\f[] bc(1), including +This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). .SH OPTIONS .PP The following are the options that bc(1) accepts. .PP -\f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] .IP .nf \f[C] -Turns\ the\ globals\ **ibase**,\ **obase**,\ and\ **scale**\ into\ stacks. +Turns the globals **ibase**, **obase**, and **scale** into stacks. -This\ has\ the\ effect\ that\ a\ copy\ of\ the\ current\ value\ of\ all\ three\ are\ pushed -onto\ a\ stack\ for\ every\ function\ call,\ as\ well\ as\ popped\ when\ every\ function -returns.\ This\ means\ that\ functions\ can\ assign\ to\ any\ and\ all\ of\ those -globals\ without\ worrying\ that\ the\ change\ will\ affect\ other\ functions. -Thus,\ a\ hypothetical\ function\ named\ **output(x,b)**\ that\ simply\ printed -**x**\ in\ base\ **b**\ could\ be\ written\ like\ this: +This has the effect that a copy of the current value of all three are pushed +onto a stack for every function call, as well as popped when every function +returns. This means that functions can assign to any and all of those +globals without worrying that the change will affect other functions. +Thus, a hypothetical function named **output(x,b)** that simply printed +**x** in base **b** could be written like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ } + define void output(x, b) { + obase=b + x + } -instead\ of\ like\ this: +instead of like this: -\ \ \ \ define\ void\ output(x,\ b)\ { -\ \ \ \ \ \ \ \ auto\ c -\ \ \ \ \ \ \ \ c=obase -\ \ \ \ \ \ \ \ obase=b -\ \ \ \ \ \ \ \ x -\ \ \ \ \ \ \ \ obase=c -\ \ \ \ } + define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c + } -This\ makes\ writing\ functions\ much\ easier. +This makes writing functions much easier. -However,\ since\ using\ this\ flag\ means\ that\ functions\ cannot\ set\ **ibase**, -**obase**,\ or\ **scale**\ globally,\ functions\ that\ are\ made\ to\ do\ so\ cannot -work\ anymore.\ There\ are\ two\ possible\ use\ cases\ for\ that,\ and\ each\ has\ a +However, since using this flag means that functions cannot set **ibase**, +**obase**, or **scale** globally, functions that are made to do so cannot +work anymore. There are two possible use cases for that, and each has a solution. -First,\ if\ a\ function\ is\ called\ on\ startup\ to\ turn\ bc(1)\ into\ a\ number -converter,\ it\ is\ possible\ to\ replace\ that\ capability\ with\ various\ shell -aliases.\ Examples: +First, if a function is called on startup to turn bc(1) into a number +converter, it is possible to replace that capability with various shell +aliases. Examples: -\ \ \ \ alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -\ \ \ \ alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" + alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] + alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] -Second,\ if\ the\ purpose\ of\ a\ function\ is\ to\ set\ **ibase**,\ **obase**,\ or -**scale**\ globally\ for\ any\ other\ purpose,\ it\ could\ be\ split\ into\ one\ to -three\ functions\ (based\ on\ how\ many\ globals\ it\ sets)\ and\ each\ of\ those -functions\ could\ return\ the\ desired\ value\ for\ a\ global. +Second, if the purpose of a function is to set **ibase**, **obase**, or +**scale** globally for any other purpose, it could be split into one to +three functions (based on how many globals it sets) and each of those +functions could return the desired value for a global. -If\ the\ behavior\ of\ this\ option\ is\ desired\ for\ every\ run\ of\ bc(1),\ then\ users -could\ make\ sure\ to\ define\ **BC_ENV_ARGS**\ and\ include\ this\ option\ (see\ the -**ENVIRONMENT\ VARIABLES**\ section\ for\ more\ details). +If the behavior of this option is desired for every run of bc(1), then users +could make sure to define **BC_ENV_ARGS** and include this option (see the +**ENVIRONMENT VARIABLES** section for more details). -If\ **\-s**,\ **\-w**,\ or\ any\ equivalents\ are\ used,\ this\ option\ is\ ignored. +If **-s**, **-w**, or any equivalents are used, this option is ignored. -This\ is\ a\ **non\-portable\ extension**. -\f[] +This is a **non-portable extension**. +\f[R] .fi .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library before running any code, including any -expressions or files specified on the command line. +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library before running any code, including +any expressions or files specified on the command line. .RS .PP -To learn what is in the library, see the \f[B]LIBRARY\f[] section. +To learn what is in the library, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -188,61 +188,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -250,268 +250,270 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Number 6 is a \f[B]non\-portable extension\f[]. +Number 6 is a \f[B]non-portable extension\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -519,205 +521,199 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -727,152 +723,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -881,73 +877,73 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP -All of the functions below are available when the \f[B]\-l\f[] or -\f[B]\-\-mathlib\f[] command\-line flags are given. +All of the functions below are available when the \f[B]-l\f[R] or +\f[B]\[en]mathlib\f[R] command-line flags are given. .SS Standard Library .PP The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Transcendental Functions .PP @@ -959,27 +955,27 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -992,7 +988,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1000,323 +996,294 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator and the corresponding assignment operator. +power (\f[B]\[ha]\f[R]) operator and the corresponding assignment +operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when bc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause bc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when bc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -bc(1) supports interactive command\-line editing. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +bc(1) supports interactive command-line editing. +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGES\f[]. +locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it -supports \f[B]LC_MESSAGES\f[]. +supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP None are known. @@ -1324,4 +1291,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/EP.1.md b/contrib/bc/manuals/bc/EP.1.md index 7e3d6aca7384..a853961d683c 100644 --- a/contrib/bc/manuals/bc/EP.1.md +++ b/contrib/bc/manuals/bc/EP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -453,7 +453,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -1069,7 +1069,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/H.1 b/contrib/bc/manuals/bc/H.1 index 48ccfb55b962..d6053feab4e8 100644 --- a/contrib/bc/manuals/bc/H.1 +++ b/contrib/bc/manuals/bc/H.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,18 +46,18 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP -.B \f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] -Turns the globals \f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], and -\f[B]seed\f[] into stacks. +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] +Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and +\f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are @@ -63,40 +65,40 @@ pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. -Thus, a hypothetical function named \f[B]output(x,b)\f[] that simply -printed \f[B]x\f[] in base \f[B]b\f[] could be written like this: +Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply +printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ obase=b -\ \ \ \ x +define void output(x, b) { + obase=b + x } -\f[] +\f[R] .fi .PP instead of like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ auto\ c -\ \ \ \ c=obase -\ \ \ \ obase=b -\ \ \ \ x -\ \ \ \ obase=c +define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c } -\f[] +\f[R] .fi .PP This makes writing functions much easier. .PP -(\f[B]Note\f[]: the function \f[B]output(x,b)\f[] exists in the extended -math library. -See the \f[B]LIBRARY\f[] section.) +(\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the +extended math library. +See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set -\f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] +\f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP @@ -107,118 +109,115 @@ Examples: .IP .nf \f[C] -alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" -\f[] +alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] +alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] +\f[R] .fi .PP -Second, if the purpose of a function is to set \f[B]ibase\f[], -\f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] globally for any other -purpose, it could be split into one to four functions (based on how many -globals it sets) and each of those functions could return the desired -value for a global. -.PP -For functions that set \f[B]seed\f[], the value assigned to -\f[B]seed\f[] is not propagated to parent functions. -This means that the sequence of pseudo\-random numbers that they see -will not be the same sequence of pseudo\-random numbers that any parent -sees. -This is only the case once \f[B]seed\f[] has been set. -.PP -If a function desires to not affect the sequence of pseudo\-random -numbers of its parents, but wants to use the same \f[B]seed\f[], it can +Second, if the purpose of a function is to set \f[B]ibase\f[R], +\f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any +other purpose, it could be split into one to four functions (based on +how many globals it sets) and each of those functions could return the +desired value for a global. +.PP +For functions that set \f[B]seed\f[R], the value assigned to +\f[B]seed\f[R] is not propagated to parent functions. +This means that the sequence of pseudo-random numbers that they see will +not be the same sequence of pseudo-random numbers that any parent sees. +This is only the case once \f[B]seed\f[R] has been set. +.PP +If a function desires to not affect the sequence of pseudo-random +numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] -seed\ =\ seed -\f[] +seed = seed +\f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then -users could make sure to define \f[B]BC_ENV_ARGS\f[] and include this -option (see the \f[B]ENVIRONMENT VARIABLES\f[] section for more +users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this +option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP -If \f[B]\-s\f[], \f[B]\-w\f[], or any equivalents are used, this option +If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library and the extended math library before +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP -To learn what is in the libraries, see the \f[B]LIBRARY\f[] section. +To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in -\f[B]BC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT VARIABLES\f[] section). +\f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -227,61 +226,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -289,388 +288,392 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]seed\f[] +\f[B]seed\f[R] .IP "7." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Numbers 6 and 7 are \f[B]non\-portable extensions\f[]. +Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP -The \f[I]scale\f[] and sign of the value may be significant. -.PP -If a previously used \f[B]seed\f[] value is assigned to \f[B]seed\f[] -and used again, the pseudo\-random number generator is guaranteed to -produce the same sequence of pseudo\-random numbers as it did when the -\f[B]seed\f[] value was previously used. -.PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if \f[B]seed\f[] is queried again immediately. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will -\f[I]not\f[] produce unique sequences of pseudo\-random numbers. -The value of \f[B]seed\f[] will change after any use of the -\f[B]rand()\f[] and \f[B]irand(E)\f[] operands (see the -\f[I]Operands\f[] subsection below), except if the parameter passed to -\f[B]irand(E)\f[] is \f[B]0\f[], \f[B]1\f[], or negative. +The \f[I]scale\f[R] and sign of the value may be significant. +.PP +If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] +and used again, the pseudo-random number generator is guaranteed to +produce the same sequence of pseudo-random numbers as it did when the +\f[B]seed\f[R] value was previously used. +.PP +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if \f[B]seed\f[R] is queried again immediately. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will +\f[I]not\f[R] produce unique sequences of pseudo-random numbers. +The value of \f[B]seed\f[R] will change after any use of the +\f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the +\f[I]Operands\f[R] subsection below), except if the parameter passed to +\f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "14." 4 -\f[B]rand()\f[]: A pseudo\-random integer between \f[B]0\f[] (inclusive) -and \f[B]BC_RAND_MAX\f[] (inclusive). -Using this operand will change the value of \f[B]seed\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). +Using this operand will change the value of \f[B]seed\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "15." 4 -\f[B]irand(E)\f[]: A pseudo\-random integer between \f[B]0\f[] -(inclusive) and the value of \f[B]E\f[] (exclusive). -If \f[B]E\f[] is negative or is a non\-integer (\f[B]E\f[]\[aq]s -\f[I]scale\f[] is not \f[B]0\f[]), an error is raised, and bc(1) resets -(see the \f[B]RESET\f[] section) while \f[B]seed\f[] remains unchanged. -If \f[B]E\f[] is larger than \f[B]BC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]BC_RAND_MAX+1\f[], and adding them +\f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and the value of \f[B]E\f[R] (exclusive). +If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s +\f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) +resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains +unchanged. +If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. -Using this operand will change the value of \f[B]seed\f[], unless the -value of \f[B]E\f[] is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is returned, and \f[B]seed\f[] is \f[I]not\f[] -changed. -This is a \f[B]non\-portable extension\f[]. +Using this operand will change the value of \f[B]seed\f[R], unless the +value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is +\f[I]not\f[R] changed. +This is a \f[B]non-portable extension\f[R]. .IP "16." 4 -\f[B]maxrand()\f[]: The max integer returned by \f[B]rand()\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. +This is a \f[B]non-portable extension\f[R]. .PP -The integers generated by \f[B]rand()\f[] and \f[B]irand(E)\f[] are +The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of -the pseudo\-random number generator. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with \f[B]rand()\f[] and \f[B]irand(E)\f[] are guaranteed to -\f[I]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[I]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. +the pseudo-random number generator. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to +\f[I]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[I]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e\-3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -Using scientific notation is an error or warning if the \f[B]\-s\f[] or -\f[B]\-w\f[], respectively, command\-line options (or equivalents) are +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +Using scientific notation is an error or warning if the \f[B]-s\f[R] or +\f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and bc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if bc(1) is given the number string -\f[B]10e\-4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if bc(1) is given the number string +\f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP -Description: \f[B]truncation\f[] +Description: \f[B]truncation\f[R] .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]set precision\f[] +Description: \f[B]set precision\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]<<\f[] \f[B]>>\f[] +\f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]shift left\f[], \f[B]shift right\f[] +Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -678,270 +681,264 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] -The \f[B]truncation\f[] operator returns a copy of the given expression -with all of its \f[I]scale\f[] removed. +\f[B]$\f[R] +The \f[B]truncation\f[R] operator returns a copy of the given expression +with all of its \f[I]scale\f[R] removed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] -The \f[B]set precision\f[] operator takes two expressions and returns a -copy of the first with its \f[I]scale\f[] equal to the value of the +\f[B]\[at]\f[R] +The \f[B]set precision\f[R] operator takes two expressions and returns a +copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if -the \f[I]scale\f[] of the first expression matches the value of the +the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE -.TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. +.TP +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]<<\f[] -The \f[B]left shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the right. +\f[B]<<\f[R] +The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the right. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]>>\f[] -The \f[B]right shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the left. +\f[B]>>\f[R] +The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the left. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .PP -The \f[B]assignment\f[] operators that correspond to operators that are -extensions are themselves \f[B]non\-portable extensions\f[]. +The \f[B]assignment\f[R] operators that correspond to operators that are +extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[], and engineering notation is activated by assigning -\f[B]1\f[] to \f[B]obase\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R], and engineering notation is activated by assigning +\f[B]1\f[R] to \f[B]obase\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is -run with either the \f[B]\-s\f[] or \f[B]\-w\f[] command\-line options +run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -951,152 +948,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -1105,23 +1102,23 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math -library (see the \f[I]Extended Library\f[] subsection below), are -available when the \f[B]\-l\f[] or \f[B]\-\-mathlib\f[] command\-line +library (see the \f[I]Extended Library\f[R] subsection below), are +available when the \f[B]-l\f[R] or \f[B]\[en]mathlib\f[R] command-line flags are given, except that the extended math library is not available -when the \f[B]\-s\f[] option, the \f[B]\-w\f[] option, or equivalents +when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP @@ -1129,545 +1126,528 @@ The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Extended Library .PP -The extended library is \f[I]not\f[] loaded when the -\f[B]\-s\f[]/\f[B]\-\-standard\f[] or \f[B]\-w\f[]/\f[B]\-\-warn\f[] +The extended library is \f[I]not\f[R] loaded when the +\f[B]-s\f[R]/\f[B]\[en]standard\f[R] or \f[B]-w\f[R]/\f[B]\[en]warn\f[R] options are given since they are not part of the library defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html). .PP -The extended library is a \f[B]non\-portable extension\f[]. +The extended library is a \f[B]non-portable extension\f[R]. .TP -.B \f[B]p(x, y)\f[] -Calculates \f[B]x\f[] to the power of \f[B]y\f[], even if \f[B]y\f[] is -not an integer, and returns the result to the current \f[B]scale\f[]. +\f[B]p(x, y)\f[R] +Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] +is not an integer, and returns the result to the current +\f[B]scale\f[R]. .RS .PP +It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is +\f[B]0\f[R]. +.PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round half away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). -.RS -.RE +\f[B]r(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round half away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP -.B \f[B]ceil(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). -.RS -.RE +\f[B]ceil(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP -.B \f[B]f(x)\f[] -Returns the factorial of the truncated absolute value of \f[B]x\f[]. -.RS -.RE +\f[B]f(x)\f[R] +Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]perm(n, k)\f[] -Returns the permutation of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]perm(n, k)\f[R] +Returns the permutation of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]comb(n, k)\f[] -Returns the combination of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]comb(n, k)\f[R] +Returns the combination of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]l2(x)\f[] -Returns the logarithm base \f[B]2\f[] of \f[B]x\f[]. +\f[B]l2(x)\f[R] +Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l10(x)\f[] -Returns the logarithm base \f[B]10\f[] of \f[B]x\f[]. +\f[B]l10(x)\f[R] +Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]log(x, b)\f[] -Returns the logarithm base \f[B]b\f[] of \f[B]x\f[]. +\f[B]log(x, b)\f[R] +Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cbrt(x)\f[] -Returns the cube root of \f[B]x\f[]. -.RS -.RE +\f[B]cbrt(x)\f[R] +Returns the cube root of \f[B]x\f[R]. .TP -.B \f[B]root(x, n)\f[] -Calculates the truncated value of \f[B]n\f[], \f[B]r\f[], and returns -the \f[B]r\f[]th root of \f[B]x\f[] to the current \f[B]scale\f[]. +\f[B]root(x, n)\f[R] +Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns +the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP -If \f[B]r\f[] is \f[B]0\f[] or negative, this raises an error and causes -bc(1) to reset (see the \f[B]RESET\f[] section). -It also raises an error and causes bc(1) to reset if \f[B]r\f[] is even -and \f[B]x\f[] is negative. +If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and +causes bc(1) to reset (see the \f[B]RESET\f[R] section). +It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even +and \f[B]x\f[R] is negative. .RE .TP -.B \f[B]pi(p)\f[] -Returns \f[B]pi\f[] to \f[B]p\f[] decimal places. +\f[B]pi(p)\f[R] +Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]t(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]t(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]a2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]a2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]sin(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]sin(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]s(x)\f[]. +This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cos(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]cos(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]c(x)\f[]. +This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]tan(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]tan(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -If \f[B]x\f[] is equal to \f[B]1\f[] or \f[B]\-1\f[], this raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an +error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP -This is an alias of \f[B]t(x)\f[]. +This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]atan(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]atan(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP -This is an alias of \f[B]a(x)\f[]. +This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]atan2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]atan2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP -This is an alias of \f[B]a2(y, x)\f[]. +This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r2d(x)\f[] -Converts \f[B]x\f[] from radians to degrees and returns the result. +\f[B]r2d(x)\f[R] +Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]d2r(x)\f[] -Converts \f[B]x\f[] from degrees to radians and returns the result. +\f[B]d2r(x)\f[R] +Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]frand(p)\f[] -Generates a pseudo\-random number between \f[B]0\f[] (inclusive) and -\f[B]1\f[] (exclusive) with the number of decimal digits after the -decimal point equal to the truncated absolute value of \f[B]p\f[]. -If \f[B]p\f[] is not \f[B]0\f[], then calling this function will change -the value of \f[B]seed\f[]. -If \f[B]p\f[] is \f[B]0\f[], then \f[B]0\f[] is returned, and -\f[B]seed\f[] is \f[I]not\f[] changed. -.RS -.RE +\f[B]frand(p)\f[R] +Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and +\f[B]1\f[R] (exclusive) with the number of decimal digits after the +decimal point equal to the truncated absolute value of \f[B]p\f[R]. +If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will +change the value of \f[B]seed\f[R]. +If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and +\f[B]seed\f[R] is \f[I]not\f[R] changed. .TP -.B \f[B]ifrand(i, p)\f[] -Generates a pseudo\-random number that is between \f[B]0\f[] (inclusive) -and the truncated absolute value of \f[B]i\f[] (exclusive) with the +\f[B]ifrand(i, p)\f[R] +Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) +and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated -absolute value of \f[B]p\f[]. -If the absolute value of \f[B]i\f[] is greater than or equal to -\f[B]2\f[], and \f[B]p\f[] is not \f[B]0\f[], then calling this function -will change the value of \f[B]seed\f[]; otherwise, \f[B]0\f[] is -returned and \f[B]seed\f[] is not changed. -.RS -.RE +absolute value of \f[B]p\f[R]. +If the absolute value of \f[B]i\f[R] is greater than or equal to +\f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this +function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] +is returned and \f[B]seed\f[R] is not changed. .TP -.B \f[B]srand(x)\f[] -Returns \f[B]x\f[] with its sign flipped with probability \f[B]0.5\f[]. -In other words, it randomizes the sign of \f[B]x\f[]. -.RS -.RE +\f[B]srand(x)\f[R] +Returns \f[B]x\f[R] with its sign flipped with probability +\f[B]0.5\f[R]. +In other words, it randomizes the sign of \f[B]x\f[R]. .TP -.B \f[B]brand()\f[] -Returns a random boolean value (either \f[B]0\f[] or \f[B]1\f[]). -.RS -.RE +\f[B]brand()\f[R] +Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP -.B \f[B]ubytes(x)\f[] +\f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the -truncated absolute value of \f[B]x\f[]. -.RS -.RE +truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]sbytes(x)\f[] -Returns the numbers of signed, two\[aq]s\-complement integer bytes -required to hold the truncated value of \f[B]x\f[]. -.RS -.RE +\f[B]sbytes(x)\f[R] +Returns the numbers of signed, two\[cq]s-complement integer bytes +required to hold the truncated value of \f[B]x\f[R]. .TP -.B \f[B]hex(x)\f[] -Outputs the hexadecimal (base \f[B]16\f[]) representation of \f[B]x\f[]. +\f[B]hex(x)\f[R] +Outputs the hexadecimal (base \f[B]16\f[R]) representation of +\f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary(x)\f[] -Outputs the binary (base \f[B]2\f[]) representation of \f[B]x\f[]. +\f[B]binary(x)\f[R] +Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output(x, b)\f[] -Outputs the base \f[B]b\f[] representation of \f[B]x\f[]. +\f[B]output(x, b)\f[R] +Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as +\f[B]uint(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or is negative, an error message is -printed instead, but bc(1) is not reset (see the \f[B]RESET\f[] +If \f[B]x\f[R] is not an integer or is negative, an error message is +printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in as few power of two bytes as +\f[B]int(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, an error message is printed instead, -but bc(1) is not reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, an error message is printed instead, +but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uintn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]n\f[] bytes. +\f[B]uintn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]n\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]intn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]n\f[] bytes. +\f[B]intn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]n\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]1\f[] byte. +\f[B]uint8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]1\f[] byte, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]1\f[] byte. +\f[B]int8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]1\f[] byte, an +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]2\f[] bytes. +\f[B]uint16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]2\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]2\f[] bytes. +\f[B]int16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]2\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]4\f[] bytes. +\f[B]uint32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]4\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]4\f[] bytes. +\f[B]int32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]4\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]8\f[] bytes. +\f[B]uint64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]8\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]8\f[] bytes. +\f[B]int64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]8\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]hex_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in hexadecimal using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]hex_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] +bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in binary using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]binary_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in the current \f[B]obase\f[] (see the -\f[B]SYNTAX\f[] section) using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]output_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see +the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_byte(x, i)\f[] -Outputs byte \f[B]i\f[] of the truncated absolute value of \f[B]x\f[], -where \f[B]0\f[] is the least significant byte and \f[B]number_of_bytes -\- 1\f[] is the most significant byte. +\f[B]output_byte(x, i)\f[R] +Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], +where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes +- 1\f[R] is the most significant byte. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP @@ -1679,55 +1659,55 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 -\f[B]l2(x)\f[] +\f[B]l2(x)\f[R] .IP \[bu] 2 -\f[B]l10(x)\f[] +\f[B]l10(x)\f[R] .IP \[bu] 2 -\f[B]log(x, b)\f[] +\f[B]log(x, b)\f[R] .IP \[bu] 2 -\f[B]pi(p)\f[] +\f[B]pi(p)\f[R] .IP \[bu] 2 -\f[B]t(x)\f[] +\f[B]t(x)\f[R] .IP \[bu] 2 -\f[B]a2(y, x)\f[] +\f[B]a2(y, x)\f[R] .IP \[bu] 2 -\f[B]sin(x)\f[] +\f[B]sin(x)\f[R] .IP \[bu] 2 -\f[B]cos(x)\f[] +\f[B]cos(x)\f[R] .IP \[bu] 2 -\f[B]tan(x)\f[] +\f[B]tan(x)\f[R] .IP \[bu] 2 -\f[B]atan(x)\f[] +\f[B]atan(x)\f[R] .IP \[bu] 2 -\f[B]atan2(y, x)\f[] +\f[B]atan2(y, x)\f[R] .IP \[bu] 2 -\f[B]r2d(x)\f[] +\f[B]r2d(x)\f[R] .IP \[bu] 2 -\f[B]d2r(x)\f[] +\f[B]d2r(x)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1740,7 +1720,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1748,320 +1728,289 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]rand()\f[] operand. -Set at \f[B]2^BC_LONG_BIT\-1\f[]. -.RS -.RE +\f[B]BC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]rand()\f[R] +operand. +Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]<<\f[]), and -right shift (\f[B]>>\f[]) operators and their corresponding assignment -operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their +corresponding assignment operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP The prompt is enabled in TTY mode. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGES\f[]. +locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it -supports \f[B]LC_MESSAGES\f[]. +supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP None are known. @@ -2069,4 +2018,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/H.1.md b/contrib/bc/manuals/bc/H.1.md index 413032534554..f764e47cc0f4 100644 --- a/contrib/bc/manuals/bc/H.1.md +++ b/contrib/bc/manuals/bc/H.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -415,9 +415,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **35**. In addition, bc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. @@ -580,7 +580,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -929,6 +929,8 @@ The extended library is a **non-portable extension**. : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. + It is an error if **y** is negative and **x** is **0**. + This is a transcendental function (see the *Transcendental Functions* subsection below). @@ -1664,7 +1666,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/HN.1 b/contrib/bc/manuals/bc/HN.1 index 9126c9209da5..6a8dd876db65 100644 --- a/contrib/bc/manuals/bc/HN.1 +++ b/contrib/bc/manuals/bc/HN.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,18 +46,18 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP -.B \f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] -Turns the globals \f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], and -\f[B]seed\f[] into stacks. +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] +Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and +\f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are @@ -63,40 +65,40 @@ pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. -Thus, a hypothetical function named \f[B]output(x,b)\f[] that simply -printed \f[B]x\f[] in base \f[B]b\f[] could be written like this: +Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply +printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ obase=b -\ \ \ \ x +define void output(x, b) { + obase=b + x } -\f[] +\f[R] .fi .PP instead of like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ auto\ c -\ \ \ \ c=obase -\ \ \ \ obase=b -\ \ \ \ x -\ \ \ \ obase=c +define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c } -\f[] +\f[R] .fi .PP This makes writing functions much easier. .PP -(\f[B]Note\f[]: the function \f[B]output(x,b)\f[] exists in the extended -math library. -See the \f[B]LIBRARY\f[] section.) +(\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the +extended math library. +See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set -\f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] +\f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP @@ -107,118 +109,115 @@ Examples: .IP .nf \f[C] -alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" -\f[] +alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] +alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] +\f[R] .fi .PP -Second, if the purpose of a function is to set \f[B]ibase\f[], -\f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] globally for any other -purpose, it could be split into one to four functions (based on how many -globals it sets) and each of those functions could return the desired -value for a global. -.PP -For functions that set \f[B]seed\f[], the value assigned to -\f[B]seed\f[] is not propagated to parent functions. -This means that the sequence of pseudo\-random numbers that they see -will not be the same sequence of pseudo\-random numbers that any parent -sees. -This is only the case once \f[B]seed\f[] has been set. -.PP -If a function desires to not affect the sequence of pseudo\-random -numbers of its parents, but wants to use the same \f[B]seed\f[], it can +Second, if the purpose of a function is to set \f[B]ibase\f[R], +\f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any +other purpose, it could be split into one to four functions (based on +how many globals it sets) and each of those functions could return the +desired value for a global. +.PP +For functions that set \f[B]seed\f[R], the value assigned to +\f[B]seed\f[R] is not propagated to parent functions. +This means that the sequence of pseudo-random numbers that they see will +not be the same sequence of pseudo-random numbers that any parent sees. +This is only the case once \f[B]seed\f[R] has been set. +.PP +If a function desires to not affect the sequence of pseudo-random +numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] -seed\ =\ seed -\f[] +seed = seed +\f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then -users could make sure to define \f[B]BC_ENV_ARGS\f[] and include this -option (see the \f[B]ENVIRONMENT VARIABLES\f[] section for more +users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this +option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP -If \f[B]\-s\f[], \f[B]\-w\f[], or any equivalents are used, this option +If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library and the extended math library before +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP -To learn what is in the libraries, see the \f[B]LIBRARY\f[] section. +To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in -\f[B]BC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT VARIABLES\f[] section). +\f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -227,61 +226,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -289,388 +288,392 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]seed\f[] +\f[B]seed\f[R] .IP "7." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Numbers 6 and 7 are \f[B]non\-portable extensions\f[]. +Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP -The \f[I]scale\f[] and sign of the value may be significant. -.PP -If a previously used \f[B]seed\f[] value is assigned to \f[B]seed\f[] -and used again, the pseudo\-random number generator is guaranteed to -produce the same sequence of pseudo\-random numbers as it did when the -\f[B]seed\f[] value was previously used. -.PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if \f[B]seed\f[] is queried again immediately. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will -\f[I]not\f[] produce unique sequences of pseudo\-random numbers. -The value of \f[B]seed\f[] will change after any use of the -\f[B]rand()\f[] and \f[B]irand(E)\f[] operands (see the -\f[I]Operands\f[] subsection below), except if the parameter passed to -\f[B]irand(E)\f[] is \f[B]0\f[], \f[B]1\f[], or negative. +The \f[I]scale\f[R] and sign of the value may be significant. +.PP +If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] +and used again, the pseudo-random number generator is guaranteed to +produce the same sequence of pseudo-random numbers as it did when the +\f[B]seed\f[R] value was previously used. +.PP +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if \f[B]seed\f[R] is queried again immediately. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will +\f[I]not\f[R] produce unique sequences of pseudo-random numbers. +The value of \f[B]seed\f[R] will change after any use of the +\f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the +\f[I]Operands\f[R] subsection below), except if the parameter passed to +\f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "14." 4 -\f[B]rand()\f[]: A pseudo\-random integer between \f[B]0\f[] (inclusive) -and \f[B]BC_RAND_MAX\f[] (inclusive). -Using this operand will change the value of \f[B]seed\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). +Using this operand will change the value of \f[B]seed\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "15." 4 -\f[B]irand(E)\f[]: A pseudo\-random integer between \f[B]0\f[] -(inclusive) and the value of \f[B]E\f[] (exclusive). -If \f[B]E\f[] is negative or is a non\-integer (\f[B]E\f[]\[aq]s -\f[I]scale\f[] is not \f[B]0\f[]), an error is raised, and bc(1) resets -(see the \f[B]RESET\f[] section) while \f[B]seed\f[] remains unchanged. -If \f[B]E\f[] is larger than \f[B]BC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]BC_RAND_MAX+1\f[], and adding them +\f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and the value of \f[B]E\f[R] (exclusive). +If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s +\f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) +resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains +unchanged. +If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. -Using this operand will change the value of \f[B]seed\f[], unless the -value of \f[B]E\f[] is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is returned, and \f[B]seed\f[] is \f[I]not\f[] -changed. -This is a \f[B]non\-portable extension\f[]. +Using this operand will change the value of \f[B]seed\f[R], unless the +value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is +\f[I]not\f[R] changed. +This is a \f[B]non-portable extension\f[R]. .IP "16." 4 -\f[B]maxrand()\f[]: The max integer returned by \f[B]rand()\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. +This is a \f[B]non-portable extension\f[R]. .PP -The integers generated by \f[B]rand()\f[] and \f[B]irand(E)\f[] are +The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of -the pseudo\-random number generator. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with \f[B]rand()\f[] and \f[B]irand(E)\f[] are guaranteed to -\f[I]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[I]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. +the pseudo-random number generator. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to +\f[I]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[I]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e\-3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -Using scientific notation is an error or warning if the \f[B]\-s\f[] or -\f[B]\-w\f[], respectively, command\-line options (or equivalents) are +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +Using scientific notation is an error or warning if the \f[B]-s\f[R] or +\f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and bc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if bc(1) is given the number string -\f[B]10e\-4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if bc(1) is given the number string +\f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP -Description: \f[B]truncation\f[] +Description: \f[B]truncation\f[R] .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]set precision\f[] +Description: \f[B]set precision\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]<<\f[] \f[B]>>\f[] +\f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]shift left\f[], \f[B]shift right\f[] +Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -678,270 +681,264 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] -The \f[B]truncation\f[] operator returns a copy of the given expression -with all of its \f[I]scale\f[] removed. +\f[B]$\f[R] +The \f[B]truncation\f[R] operator returns a copy of the given expression +with all of its \f[I]scale\f[R] removed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] -The \f[B]set precision\f[] operator takes two expressions and returns a -copy of the first with its \f[I]scale\f[] equal to the value of the +\f[B]\[at]\f[R] +The \f[B]set precision\f[R] operator takes two expressions and returns a +copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if -the \f[I]scale\f[] of the first expression matches the value of the +the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE -.TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. +.TP +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]<<\f[] -The \f[B]left shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the right. +\f[B]<<\f[R] +The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the right. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]>>\f[] -The \f[B]right shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the left. +\f[B]>>\f[R] +The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the left. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .PP -The \f[B]assignment\f[] operators that correspond to operators that are -extensions are themselves \f[B]non\-portable extensions\f[]. +The \f[B]assignment\f[R] operators that correspond to operators that are +extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[], and engineering notation is activated by assigning -\f[B]1\f[] to \f[B]obase\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R], and engineering notation is activated by assigning +\f[B]1\f[R] to \f[B]obase\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is -run with either the \f[B]\-s\f[] or \f[B]\-w\f[] command\-line options +run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -951,152 +948,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -1105,23 +1102,23 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math -library (see the \f[I]Extended Library\f[] subsection below), are -available when the \f[B]\-l\f[] or \f[B]\-\-mathlib\f[] command\-line +library (see the \f[I]Extended Library\f[R] subsection below), are +available when the \f[B]-l\f[R] or \f[B]\[en]mathlib\f[R] command-line flags are given, except that the extended math library is not available -when the \f[B]\-s\f[] option, the \f[B]\-w\f[] option, or equivalents +when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP @@ -1129,545 +1126,528 @@ The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Extended Library .PP -The extended library is \f[I]not\f[] loaded when the -\f[B]\-s\f[]/\f[B]\-\-standard\f[] or \f[B]\-w\f[]/\f[B]\-\-warn\f[] +The extended library is \f[I]not\f[R] loaded when the +\f[B]-s\f[R]/\f[B]\[en]standard\f[R] or \f[B]-w\f[R]/\f[B]\[en]warn\f[R] options are given since they are not part of the library defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html). .PP -The extended library is a \f[B]non\-portable extension\f[]. +The extended library is a \f[B]non-portable extension\f[R]. .TP -.B \f[B]p(x, y)\f[] -Calculates \f[B]x\f[] to the power of \f[B]y\f[], even if \f[B]y\f[] is -not an integer, and returns the result to the current \f[B]scale\f[]. +\f[B]p(x, y)\f[R] +Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] +is not an integer, and returns the result to the current +\f[B]scale\f[R]. .RS .PP +It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is +\f[B]0\f[R]. +.PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round half away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). -.RS -.RE +\f[B]r(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round half away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP -.B \f[B]ceil(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). -.RS -.RE +\f[B]ceil(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP -.B \f[B]f(x)\f[] -Returns the factorial of the truncated absolute value of \f[B]x\f[]. -.RS -.RE +\f[B]f(x)\f[R] +Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]perm(n, k)\f[] -Returns the permutation of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]perm(n, k)\f[R] +Returns the permutation of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]comb(n, k)\f[] -Returns the combination of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]comb(n, k)\f[R] +Returns the combination of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]l2(x)\f[] -Returns the logarithm base \f[B]2\f[] of \f[B]x\f[]. +\f[B]l2(x)\f[R] +Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l10(x)\f[] -Returns the logarithm base \f[B]10\f[] of \f[B]x\f[]. +\f[B]l10(x)\f[R] +Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]log(x, b)\f[] -Returns the logarithm base \f[B]b\f[] of \f[B]x\f[]. +\f[B]log(x, b)\f[R] +Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cbrt(x)\f[] -Returns the cube root of \f[B]x\f[]. -.RS -.RE +\f[B]cbrt(x)\f[R] +Returns the cube root of \f[B]x\f[R]. .TP -.B \f[B]root(x, n)\f[] -Calculates the truncated value of \f[B]n\f[], \f[B]r\f[], and returns -the \f[B]r\f[]th root of \f[B]x\f[] to the current \f[B]scale\f[]. +\f[B]root(x, n)\f[R] +Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns +the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP -If \f[B]r\f[] is \f[B]0\f[] or negative, this raises an error and causes -bc(1) to reset (see the \f[B]RESET\f[] section). -It also raises an error and causes bc(1) to reset if \f[B]r\f[] is even -and \f[B]x\f[] is negative. +If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and +causes bc(1) to reset (see the \f[B]RESET\f[R] section). +It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even +and \f[B]x\f[R] is negative. .RE .TP -.B \f[B]pi(p)\f[] -Returns \f[B]pi\f[] to \f[B]p\f[] decimal places. +\f[B]pi(p)\f[R] +Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]t(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]t(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]a2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]a2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]sin(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]sin(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]s(x)\f[]. +This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cos(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]cos(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]c(x)\f[]. +This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]tan(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]tan(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -If \f[B]x\f[] is equal to \f[B]1\f[] or \f[B]\-1\f[], this raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an +error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP -This is an alias of \f[B]t(x)\f[]. +This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]atan(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]atan(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP -This is an alias of \f[B]a(x)\f[]. +This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]atan2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]atan2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP -This is an alias of \f[B]a2(y, x)\f[]. +This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r2d(x)\f[] -Converts \f[B]x\f[] from radians to degrees and returns the result. +\f[B]r2d(x)\f[R] +Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]d2r(x)\f[] -Converts \f[B]x\f[] from degrees to radians and returns the result. +\f[B]d2r(x)\f[R] +Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]frand(p)\f[] -Generates a pseudo\-random number between \f[B]0\f[] (inclusive) and -\f[B]1\f[] (exclusive) with the number of decimal digits after the -decimal point equal to the truncated absolute value of \f[B]p\f[]. -If \f[B]p\f[] is not \f[B]0\f[], then calling this function will change -the value of \f[B]seed\f[]. -If \f[B]p\f[] is \f[B]0\f[], then \f[B]0\f[] is returned, and -\f[B]seed\f[] is \f[I]not\f[] changed. -.RS -.RE +\f[B]frand(p)\f[R] +Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and +\f[B]1\f[R] (exclusive) with the number of decimal digits after the +decimal point equal to the truncated absolute value of \f[B]p\f[R]. +If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will +change the value of \f[B]seed\f[R]. +If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and +\f[B]seed\f[R] is \f[I]not\f[R] changed. .TP -.B \f[B]ifrand(i, p)\f[] -Generates a pseudo\-random number that is between \f[B]0\f[] (inclusive) -and the truncated absolute value of \f[B]i\f[] (exclusive) with the +\f[B]ifrand(i, p)\f[R] +Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) +and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated -absolute value of \f[B]p\f[]. -If the absolute value of \f[B]i\f[] is greater than or equal to -\f[B]2\f[], and \f[B]p\f[] is not \f[B]0\f[], then calling this function -will change the value of \f[B]seed\f[]; otherwise, \f[B]0\f[] is -returned and \f[B]seed\f[] is not changed. -.RS -.RE +absolute value of \f[B]p\f[R]. +If the absolute value of \f[B]i\f[R] is greater than or equal to +\f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this +function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] +is returned and \f[B]seed\f[R] is not changed. .TP -.B \f[B]srand(x)\f[] -Returns \f[B]x\f[] with its sign flipped with probability \f[B]0.5\f[]. -In other words, it randomizes the sign of \f[B]x\f[]. -.RS -.RE +\f[B]srand(x)\f[R] +Returns \f[B]x\f[R] with its sign flipped with probability +\f[B]0.5\f[R]. +In other words, it randomizes the sign of \f[B]x\f[R]. .TP -.B \f[B]brand()\f[] -Returns a random boolean value (either \f[B]0\f[] or \f[B]1\f[]). -.RS -.RE +\f[B]brand()\f[R] +Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP -.B \f[B]ubytes(x)\f[] +\f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the -truncated absolute value of \f[B]x\f[]. -.RS -.RE +truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]sbytes(x)\f[] -Returns the numbers of signed, two\[aq]s\-complement integer bytes -required to hold the truncated value of \f[B]x\f[]. -.RS -.RE +\f[B]sbytes(x)\f[R] +Returns the numbers of signed, two\[cq]s-complement integer bytes +required to hold the truncated value of \f[B]x\f[R]. .TP -.B \f[B]hex(x)\f[] -Outputs the hexadecimal (base \f[B]16\f[]) representation of \f[B]x\f[]. +\f[B]hex(x)\f[R] +Outputs the hexadecimal (base \f[B]16\f[R]) representation of +\f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary(x)\f[] -Outputs the binary (base \f[B]2\f[]) representation of \f[B]x\f[]. +\f[B]binary(x)\f[R] +Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output(x, b)\f[] -Outputs the base \f[B]b\f[] representation of \f[B]x\f[]. +\f[B]output(x, b)\f[R] +Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as +\f[B]uint(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or is negative, an error message is -printed instead, but bc(1) is not reset (see the \f[B]RESET\f[] +If \f[B]x\f[R] is not an integer or is negative, an error message is +printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in as few power of two bytes as +\f[B]int(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, an error message is printed instead, -but bc(1) is not reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, an error message is printed instead, +but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uintn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]n\f[] bytes. +\f[B]uintn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]n\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]intn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]n\f[] bytes. +\f[B]intn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]n\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]1\f[] byte. +\f[B]uint8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]1\f[] byte, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]1\f[] byte. +\f[B]int8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]1\f[] byte, an +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]2\f[] bytes. +\f[B]uint16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]2\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]2\f[] bytes. +\f[B]int16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]2\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]4\f[] bytes. +\f[B]uint32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]4\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]4\f[] bytes. +\f[B]int32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]4\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]8\f[] bytes. +\f[B]uint64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]8\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]8\f[] bytes. +\f[B]int64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]8\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]hex_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in hexadecimal using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]hex_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] +bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in binary using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]binary_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in the current \f[B]obase\f[] (see the -\f[B]SYNTAX\f[] section) using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]output_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see +the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_byte(x, i)\f[] -Outputs byte \f[B]i\f[] of the truncated absolute value of \f[B]x\f[], -where \f[B]0\f[] is the least significant byte and \f[B]number_of_bytes -\- 1\f[] is the most significant byte. +\f[B]output_byte(x, i)\f[R] +Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], +where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes +- 1\f[R] is the most significant byte. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP @@ -1679,55 +1659,55 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 -\f[B]l2(x)\f[] +\f[B]l2(x)\f[R] .IP \[bu] 2 -\f[B]l10(x)\f[] +\f[B]l10(x)\f[R] .IP \[bu] 2 -\f[B]log(x, b)\f[] +\f[B]log(x, b)\f[R] .IP \[bu] 2 -\f[B]pi(p)\f[] +\f[B]pi(p)\f[R] .IP \[bu] 2 -\f[B]t(x)\f[] +\f[B]t(x)\f[R] .IP \[bu] 2 -\f[B]a2(y, x)\f[] +\f[B]a2(y, x)\f[R] .IP \[bu] 2 -\f[B]sin(x)\f[] +\f[B]sin(x)\f[R] .IP \[bu] 2 -\f[B]cos(x)\f[] +\f[B]cos(x)\f[R] .IP \[bu] 2 -\f[B]tan(x)\f[] +\f[B]tan(x)\f[R] .IP \[bu] 2 -\f[B]atan(x)\f[] +\f[B]atan(x)\f[R] .IP \[bu] 2 -\f[B]atan2(y, x)\f[] +\f[B]atan2(y, x)\f[R] .IP \[bu] 2 -\f[B]r2d(x)\f[] +\f[B]r2d(x)\f[R] .IP \[bu] 2 -\f[B]d2r(x)\f[] +\f[B]d2r(x)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1740,7 +1720,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1748,313 +1728,282 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]rand()\f[] operand. -Set at \f[B]2^BC_LONG_BIT\-1\f[]. -.RS -.RE +\f[B]BC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]rand()\f[R] +operand. +Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]<<\f[]), and -right shift (\f[B]>>\f[]) operators and their corresponding assignment -operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their +corresponding assignment operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP The prompt is enabled in TTY mode. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP None are known. @@ -2062,4 +2011,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/HN.1.md b/contrib/bc/manuals/bc/HN.1.md index c9ac146efbb2..9cc71c3be057 100644 --- a/contrib/bc/manuals/bc/HN.1.md +++ b/contrib/bc/manuals/bc/HN.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -415,9 +415,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **35**. In addition, bc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. @@ -580,7 +580,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -929,6 +929,8 @@ The extended library is a **non-portable extension**. : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. + It is an error if **y** is negative and **x** is **0**. + This is a transcendental function (see the *Transcendental Functions* subsection below). @@ -1656,7 +1658,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/HNP.1 b/contrib/bc/manuals/bc/HNP.1 index ad09513f0528..30a8b00a5009 100644 --- a/contrib/bc/manuals/bc/HNP.1 +++ b/contrib/bc/manuals/bc/HNP.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,18 +46,18 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP -.B \f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] -Turns the globals \f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], and -\f[B]seed\f[] into stacks. +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] +Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and +\f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are @@ -63,40 +65,40 @@ pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. -Thus, a hypothetical function named \f[B]output(x,b)\f[] that simply -printed \f[B]x\f[] in base \f[B]b\f[] could be written like this: +Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply +printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ obase=b -\ \ \ \ x +define void output(x, b) { + obase=b + x } -\f[] +\f[R] .fi .PP instead of like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ auto\ c -\ \ \ \ c=obase -\ \ \ \ obase=b -\ \ \ \ x -\ \ \ \ obase=c +define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c } -\f[] +\f[R] .fi .PP This makes writing functions much easier. .PP -(\f[B]Note\f[]: the function \f[B]output(x,b)\f[] exists in the extended -math library. -See the \f[B]LIBRARY\f[] section.) +(\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the +extended math library. +See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set -\f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] +\f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP @@ -107,113 +109,110 @@ Examples: .IP .nf \f[C] -alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" -\f[] +alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] +alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] +\f[R] .fi .PP -Second, if the purpose of a function is to set \f[B]ibase\f[], -\f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] globally for any other -purpose, it could be split into one to four functions (based on how many -globals it sets) and each of those functions could return the desired -value for a global. -.PP -For functions that set \f[B]seed\f[], the value assigned to -\f[B]seed\f[] is not propagated to parent functions. -This means that the sequence of pseudo\-random numbers that they see -will not be the same sequence of pseudo\-random numbers that any parent -sees. -This is only the case once \f[B]seed\f[] has been set. -.PP -If a function desires to not affect the sequence of pseudo\-random -numbers of its parents, but wants to use the same \f[B]seed\f[], it can +Second, if the purpose of a function is to set \f[B]ibase\f[R], +\f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any +other purpose, it could be split into one to four functions (based on +how many globals it sets) and each of those functions could return the +desired value for a global. +.PP +For functions that set \f[B]seed\f[R], the value assigned to +\f[B]seed\f[R] is not propagated to parent functions. +This means that the sequence of pseudo-random numbers that they see will +not be the same sequence of pseudo-random numbers that any parent sees. +This is only the case once \f[B]seed\f[R] has been set. +.PP +If a function desires to not affect the sequence of pseudo-random +numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] -seed\ =\ seed -\f[] +seed = seed +\f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then -users could make sure to define \f[B]BC_ENV_ARGS\f[] and include this -option (see the \f[B]ENVIRONMENT VARIABLES\f[] section for more +users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this +option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP -If \f[B]\-s\f[], \f[B]\-w\f[], or any equivalents are used, this option +If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library and the extended math library before +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP -To learn what is in the libraries, see the \f[B]LIBRARY\f[] section. +To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -222,61 +221,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -284,388 +283,392 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]seed\f[] +\f[B]seed\f[R] .IP "7." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Numbers 6 and 7 are \f[B]non\-portable extensions\f[]. +Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP -The \f[I]scale\f[] and sign of the value may be significant. -.PP -If a previously used \f[B]seed\f[] value is assigned to \f[B]seed\f[] -and used again, the pseudo\-random number generator is guaranteed to -produce the same sequence of pseudo\-random numbers as it did when the -\f[B]seed\f[] value was previously used. -.PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if \f[B]seed\f[] is queried again immediately. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will -\f[I]not\f[] produce unique sequences of pseudo\-random numbers. -The value of \f[B]seed\f[] will change after any use of the -\f[B]rand()\f[] and \f[B]irand(E)\f[] operands (see the -\f[I]Operands\f[] subsection below), except if the parameter passed to -\f[B]irand(E)\f[] is \f[B]0\f[], \f[B]1\f[], or negative. +The \f[I]scale\f[R] and sign of the value may be significant. +.PP +If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] +and used again, the pseudo-random number generator is guaranteed to +produce the same sequence of pseudo-random numbers as it did when the +\f[B]seed\f[R] value was previously used. +.PP +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if \f[B]seed\f[R] is queried again immediately. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will +\f[I]not\f[R] produce unique sequences of pseudo-random numbers. +The value of \f[B]seed\f[R] will change after any use of the +\f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the +\f[I]Operands\f[R] subsection below), except if the parameter passed to +\f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "14." 4 -\f[B]rand()\f[]: A pseudo\-random integer between \f[B]0\f[] (inclusive) -and \f[B]BC_RAND_MAX\f[] (inclusive). -Using this operand will change the value of \f[B]seed\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). +Using this operand will change the value of \f[B]seed\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "15." 4 -\f[B]irand(E)\f[]: A pseudo\-random integer between \f[B]0\f[] -(inclusive) and the value of \f[B]E\f[] (exclusive). -If \f[B]E\f[] is negative or is a non\-integer (\f[B]E\f[]\[aq]s -\f[I]scale\f[] is not \f[B]0\f[]), an error is raised, and bc(1) resets -(see the \f[B]RESET\f[] section) while \f[B]seed\f[] remains unchanged. -If \f[B]E\f[] is larger than \f[B]BC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]BC_RAND_MAX+1\f[], and adding them +\f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and the value of \f[B]E\f[R] (exclusive). +If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s +\f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) +resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains +unchanged. +If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. -Using this operand will change the value of \f[B]seed\f[], unless the -value of \f[B]E\f[] is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is returned, and \f[B]seed\f[] is \f[I]not\f[] -changed. -This is a \f[B]non\-portable extension\f[]. +Using this operand will change the value of \f[B]seed\f[R], unless the +value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is +\f[I]not\f[R] changed. +This is a \f[B]non-portable extension\f[R]. .IP "16." 4 -\f[B]maxrand()\f[]: The max integer returned by \f[B]rand()\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. +This is a \f[B]non-portable extension\f[R]. .PP -The integers generated by \f[B]rand()\f[] and \f[B]irand(E)\f[] are +The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of -the pseudo\-random number generator. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with \f[B]rand()\f[] and \f[B]irand(E)\f[] are guaranteed to -\f[I]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[I]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. +the pseudo-random number generator. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to +\f[I]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[I]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e\-3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -Using scientific notation is an error or warning if the \f[B]\-s\f[] or -\f[B]\-w\f[], respectively, command\-line options (or equivalents) are +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +Using scientific notation is an error or warning if the \f[B]-s\f[R] or +\f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and bc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if bc(1) is given the number string -\f[B]10e\-4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if bc(1) is given the number string +\f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP -Description: \f[B]truncation\f[] +Description: \f[B]truncation\f[R] .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]set precision\f[] +Description: \f[B]set precision\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]<<\f[] \f[B]>>\f[] +\f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]shift left\f[], \f[B]shift right\f[] +Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -673,270 +676,264 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] -The \f[B]truncation\f[] operator returns a copy of the given expression -with all of its \f[I]scale\f[] removed. +\f[B]$\f[R] +The \f[B]truncation\f[R] operator returns a copy of the given expression +with all of its \f[I]scale\f[R] removed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] -The \f[B]set precision\f[] operator takes two expressions and returns a -copy of the first with its \f[I]scale\f[] equal to the value of the +\f[B]\[at]\f[R] +The \f[B]set precision\f[R] operator takes two expressions and returns a +copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if -the \f[I]scale\f[] of the first expression matches the value of the +the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE -.TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. +.TP +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]<<\f[] -The \f[B]left shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the right. +\f[B]<<\f[R] +The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the right. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]>>\f[] -The \f[B]right shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the left. +\f[B]>>\f[R] +The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the left. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .PP -The \f[B]assignment\f[] operators that correspond to operators that are -extensions are themselves \f[B]non\-portable extensions\f[]. +The \f[B]assignment\f[R] operators that correspond to operators that are +extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[], and engineering notation is activated by assigning -\f[B]1\f[] to \f[B]obase\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R], and engineering notation is activated by assigning +\f[B]1\f[R] to \f[B]obase\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is -run with either the \f[B]\-s\f[] or \f[B]\-w\f[] command\-line options +run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -946,152 +943,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -1100,23 +1097,23 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math -library (see the \f[I]Extended Library\f[] subsection below), are -available when the \f[B]\-l\f[] or \f[B]\-\-mathlib\f[] command\-line +library (see the \f[I]Extended Library\f[R] subsection below), are +available when the \f[B]-l\f[R] or \f[B]\[en]mathlib\f[R] command-line flags are given, except that the extended math library is not available -when the \f[B]\-s\f[] option, the \f[B]\-w\f[] option, or equivalents +when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP @@ -1124,545 +1121,528 @@ The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Extended Library .PP -The extended library is \f[I]not\f[] loaded when the -\f[B]\-s\f[]/\f[B]\-\-standard\f[] or \f[B]\-w\f[]/\f[B]\-\-warn\f[] +The extended library is \f[I]not\f[R] loaded when the +\f[B]-s\f[R]/\f[B]\[en]standard\f[R] or \f[B]-w\f[R]/\f[B]\[en]warn\f[R] options are given since they are not part of the library defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html). .PP -The extended library is a \f[B]non\-portable extension\f[]. +The extended library is a \f[B]non-portable extension\f[R]. .TP -.B \f[B]p(x, y)\f[] -Calculates \f[B]x\f[] to the power of \f[B]y\f[], even if \f[B]y\f[] is -not an integer, and returns the result to the current \f[B]scale\f[]. +\f[B]p(x, y)\f[R] +Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] +is not an integer, and returns the result to the current +\f[B]scale\f[R]. .RS .PP +It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is +\f[B]0\f[R]. +.PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round half away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). -.RS -.RE +\f[B]r(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round half away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP -.B \f[B]ceil(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). -.RS -.RE +\f[B]ceil(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP -.B \f[B]f(x)\f[] -Returns the factorial of the truncated absolute value of \f[B]x\f[]. -.RS -.RE +\f[B]f(x)\f[R] +Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]perm(n, k)\f[] -Returns the permutation of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]perm(n, k)\f[R] +Returns the permutation of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]comb(n, k)\f[] -Returns the combination of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]comb(n, k)\f[R] +Returns the combination of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]l2(x)\f[] -Returns the logarithm base \f[B]2\f[] of \f[B]x\f[]. +\f[B]l2(x)\f[R] +Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l10(x)\f[] -Returns the logarithm base \f[B]10\f[] of \f[B]x\f[]. +\f[B]l10(x)\f[R] +Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]log(x, b)\f[] -Returns the logarithm base \f[B]b\f[] of \f[B]x\f[]. +\f[B]log(x, b)\f[R] +Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cbrt(x)\f[] -Returns the cube root of \f[B]x\f[]. -.RS -.RE +\f[B]cbrt(x)\f[R] +Returns the cube root of \f[B]x\f[R]. .TP -.B \f[B]root(x, n)\f[] -Calculates the truncated value of \f[B]n\f[], \f[B]r\f[], and returns -the \f[B]r\f[]th root of \f[B]x\f[] to the current \f[B]scale\f[]. +\f[B]root(x, n)\f[R] +Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns +the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP -If \f[B]r\f[] is \f[B]0\f[] or negative, this raises an error and causes -bc(1) to reset (see the \f[B]RESET\f[] section). -It also raises an error and causes bc(1) to reset if \f[B]r\f[] is even -and \f[B]x\f[] is negative. +If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and +causes bc(1) to reset (see the \f[B]RESET\f[R] section). +It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even +and \f[B]x\f[R] is negative. .RE .TP -.B \f[B]pi(p)\f[] -Returns \f[B]pi\f[] to \f[B]p\f[] decimal places. +\f[B]pi(p)\f[R] +Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]t(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]t(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]a2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]a2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]sin(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]sin(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]s(x)\f[]. +This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cos(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]cos(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]c(x)\f[]. +This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]tan(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]tan(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -If \f[B]x\f[] is equal to \f[B]1\f[] or \f[B]\-1\f[], this raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an +error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP -This is an alias of \f[B]t(x)\f[]. +This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]atan(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]atan(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP -This is an alias of \f[B]a(x)\f[]. +This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]atan2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]atan2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP -This is an alias of \f[B]a2(y, x)\f[]. +This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r2d(x)\f[] -Converts \f[B]x\f[] from radians to degrees and returns the result. +\f[B]r2d(x)\f[R] +Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]d2r(x)\f[] -Converts \f[B]x\f[] from degrees to radians and returns the result. +\f[B]d2r(x)\f[R] +Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]frand(p)\f[] -Generates a pseudo\-random number between \f[B]0\f[] (inclusive) and -\f[B]1\f[] (exclusive) with the number of decimal digits after the -decimal point equal to the truncated absolute value of \f[B]p\f[]. -If \f[B]p\f[] is not \f[B]0\f[], then calling this function will change -the value of \f[B]seed\f[]. -If \f[B]p\f[] is \f[B]0\f[], then \f[B]0\f[] is returned, and -\f[B]seed\f[] is \f[I]not\f[] changed. -.RS -.RE +\f[B]frand(p)\f[R] +Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and +\f[B]1\f[R] (exclusive) with the number of decimal digits after the +decimal point equal to the truncated absolute value of \f[B]p\f[R]. +If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will +change the value of \f[B]seed\f[R]. +If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and +\f[B]seed\f[R] is \f[I]not\f[R] changed. .TP -.B \f[B]ifrand(i, p)\f[] -Generates a pseudo\-random number that is between \f[B]0\f[] (inclusive) -and the truncated absolute value of \f[B]i\f[] (exclusive) with the +\f[B]ifrand(i, p)\f[R] +Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) +and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated -absolute value of \f[B]p\f[]. -If the absolute value of \f[B]i\f[] is greater than or equal to -\f[B]2\f[], and \f[B]p\f[] is not \f[B]0\f[], then calling this function -will change the value of \f[B]seed\f[]; otherwise, \f[B]0\f[] is -returned and \f[B]seed\f[] is not changed. -.RS -.RE +absolute value of \f[B]p\f[R]. +If the absolute value of \f[B]i\f[R] is greater than or equal to +\f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this +function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] +is returned and \f[B]seed\f[R] is not changed. .TP -.B \f[B]srand(x)\f[] -Returns \f[B]x\f[] with its sign flipped with probability \f[B]0.5\f[]. -In other words, it randomizes the sign of \f[B]x\f[]. -.RS -.RE +\f[B]srand(x)\f[R] +Returns \f[B]x\f[R] with its sign flipped with probability +\f[B]0.5\f[R]. +In other words, it randomizes the sign of \f[B]x\f[R]. .TP -.B \f[B]brand()\f[] -Returns a random boolean value (either \f[B]0\f[] or \f[B]1\f[]). -.RS -.RE +\f[B]brand()\f[R] +Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP -.B \f[B]ubytes(x)\f[] +\f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the -truncated absolute value of \f[B]x\f[]. -.RS -.RE +truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]sbytes(x)\f[] -Returns the numbers of signed, two\[aq]s\-complement integer bytes -required to hold the truncated value of \f[B]x\f[]. -.RS -.RE +\f[B]sbytes(x)\f[R] +Returns the numbers of signed, two\[cq]s-complement integer bytes +required to hold the truncated value of \f[B]x\f[R]. .TP -.B \f[B]hex(x)\f[] -Outputs the hexadecimal (base \f[B]16\f[]) representation of \f[B]x\f[]. +\f[B]hex(x)\f[R] +Outputs the hexadecimal (base \f[B]16\f[R]) representation of +\f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary(x)\f[] -Outputs the binary (base \f[B]2\f[]) representation of \f[B]x\f[]. +\f[B]binary(x)\f[R] +Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output(x, b)\f[] -Outputs the base \f[B]b\f[] representation of \f[B]x\f[]. +\f[B]output(x, b)\f[R] +Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as +\f[B]uint(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or is negative, an error message is -printed instead, but bc(1) is not reset (see the \f[B]RESET\f[] +If \f[B]x\f[R] is not an integer or is negative, an error message is +printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in as few power of two bytes as +\f[B]int(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, an error message is printed instead, -but bc(1) is not reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, an error message is printed instead, +but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uintn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]n\f[] bytes. +\f[B]uintn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]n\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]intn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]n\f[] bytes. +\f[B]intn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]n\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]1\f[] byte. +\f[B]uint8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]1\f[] byte, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]1\f[] byte. +\f[B]int8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]1\f[] byte, an +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]2\f[] bytes. +\f[B]uint16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]2\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]2\f[] bytes. +\f[B]int16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]2\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]4\f[] bytes. +\f[B]uint32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]4\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]4\f[] bytes. +\f[B]int32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]4\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]8\f[] bytes. +\f[B]uint64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]8\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]8\f[] bytes. +\f[B]int64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]8\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]hex_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in hexadecimal using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]hex_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] +bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in binary using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]binary_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in the current \f[B]obase\f[] (see the -\f[B]SYNTAX\f[] section) using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]output_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see +the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_byte(x, i)\f[] -Outputs byte \f[B]i\f[] of the truncated absolute value of \f[B]x\f[], -where \f[B]0\f[] is the least significant byte and \f[B]number_of_bytes -\- 1\f[] is the most significant byte. +\f[B]output_byte(x, i)\f[R] +Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], +where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes +- 1\f[R] is the most significant byte. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP @@ -1674,55 +1654,55 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 -\f[B]l2(x)\f[] +\f[B]l2(x)\f[R] .IP \[bu] 2 -\f[B]l10(x)\f[] +\f[B]l10(x)\f[R] .IP \[bu] 2 -\f[B]log(x, b)\f[] +\f[B]log(x, b)\f[R] .IP \[bu] 2 -\f[B]pi(p)\f[] +\f[B]pi(p)\f[R] .IP \[bu] 2 -\f[B]t(x)\f[] +\f[B]t(x)\f[R] .IP \[bu] 2 -\f[B]a2(y, x)\f[] +\f[B]a2(y, x)\f[R] .IP \[bu] 2 -\f[B]sin(x)\f[] +\f[B]sin(x)\f[R] .IP \[bu] 2 -\f[B]cos(x)\f[] +\f[B]cos(x)\f[R] .IP \[bu] 2 -\f[B]tan(x)\f[] +\f[B]tan(x)\f[R] .IP \[bu] 2 -\f[B]atan(x)\f[] +\f[B]atan(x)\f[R] .IP \[bu] 2 -\f[B]atan2(y, x)\f[] +\f[B]atan2(y, x)\f[R] .IP \[bu] 2 -\f[B]r2d(x)\f[] +\f[B]r2d(x)\f[R] .IP \[bu] 2 -\f[B]d2r(x)\f[] +\f[B]d2r(x)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1735,7 +1715,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1743,311 +1723,280 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]rand()\f[] operand. -Set at \f[B]2^BC_LONG_BIT\-1\f[]. -.RS -.RE +\f[B]BC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]rand()\f[R] +operand. +Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]<<\f[]), and -right shift (\f[B]>>\f[]) operators and their corresponding assignment -operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their +corresponding assignment operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP None are known. @@ -2055,4 +2004,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/HNP.1.md b/contrib/bc/manuals/bc/HNP.1.md index dc8c70ac09a9..0425073d1c08 100644 --- a/contrib/bc/manuals/bc/HNP.1.md +++ b/contrib/bc/manuals/bc/HNP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -411,9 +411,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **35**. In addition, bc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. @@ -576,7 +576,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -925,6 +925,8 @@ The extended library is a **non-portable extension**. : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. + It is an error if **y** is negative and **x** is **0**. + This is a transcendental function (see the *Transcendental Functions* subsection below). @@ -1650,7 +1652,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/HP.1 b/contrib/bc/manuals/bc/HP.1 index 3ede3a2d5ca8..2ece4e38cbd1 100644 --- a/contrib/bc/manuals/bc/HP.1 +++ b/contrib/bc/manuals/bc/HP.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,18 +46,18 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .SH OPTIONS .PP The following are the options that bc(1) accepts. .TP -.B \f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] -Turns the globals \f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], and -\f[B]seed\f[] into stacks. +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] +Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and +\f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are @@ -63,40 +65,40 @@ pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. -Thus, a hypothetical function named \f[B]output(x,b)\f[] that simply -printed \f[B]x\f[] in base \f[B]b\f[] could be written like this: +Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply +printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ obase=b -\ \ \ \ x +define void output(x, b) { + obase=b + x } -\f[] +\f[R] .fi .PP instead of like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ auto\ c -\ \ \ \ c=obase -\ \ \ \ obase=b -\ \ \ \ x -\ \ \ \ obase=c +define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c } -\f[] +\f[R] .fi .PP This makes writing functions much easier. .PP -(\f[B]Note\f[]: the function \f[B]output(x,b)\f[] exists in the extended -math library. -See the \f[B]LIBRARY\f[] section.) +(\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the +extended math library. +See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set -\f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] +\f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP @@ -107,113 +109,110 @@ Examples: .IP .nf \f[C] -alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" -\f[] +alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] +alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] +\f[R] .fi .PP -Second, if the purpose of a function is to set \f[B]ibase\f[], -\f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] globally for any other -purpose, it could be split into one to four functions (based on how many -globals it sets) and each of those functions could return the desired -value for a global. -.PP -For functions that set \f[B]seed\f[], the value assigned to -\f[B]seed\f[] is not propagated to parent functions. -This means that the sequence of pseudo\-random numbers that they see -will not be the same sequence of pseudo\-random numbers that any parent -sees. -This is only the case once \f[B]seed\f[] has been set. -.PP -If a function desires to not affect the sequence of pseudo\-random -numbers of its parents, but wants to use the same \f[B]seed\f[], it can +Second, if the purpose of a function is to set \f[B]ibase\f[R], +\f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any +other purpose, it could be split into one to four functions (based on +how many globals it sets) and each of those functions could return the +desired value for a global. +.PP +For functions that set \f[B]seed\f[R], the value assigned to +\f[B]seed\f[R] is not propagated to parent functions. +This means that the sequence of pseudo-random numbers that they see will +not be the same sequence of pseudo-random numbers that any parent sees. +This is only the case once \f[B]seed\f[R] has been set. +.PP +If a function desires to not affect the sequence of pseudo-random +numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] -seed\ =\ seed -\f[] +seed = seed +\f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then -users could make sure to define \f[B]BC_ENV_ARGS\f[] and include this -option (see the \f[B]ENVIRONMENT VARIABLES\f[] section for more +users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this +option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP -If \f[B]\-s\f[], \f[B]\-w\f[], or any equivalents are used, this option +If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library and the extended math library before +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP -To learn what is in the libraries, see the \f[B]LIBRARY\f[] section. +To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -222,61 +221,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -284,388 +283,392 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]seed\f[] +\f[B]seed\f[R] .IP "7." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Numbers 6 and 7 are \f[B]non\-portable extensions\f[]. +Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP -The \f[I]scale\f[] and sign of the value may be significant. -.PP -If a previously used \f[B]seed\f[] value is assigned to \f[B]seed\f[] -and used again, the pseudo\-random number generator is guaranteed to -produce the same sequence of pseudo\-random numbers as it did when the -\f[B]seed\f[] value was previously used. -.PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if \f[B]seed\f[] is queried again immediately. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will -\f[I]not\f[] produce unique sequences of pseudo\-random numbers. -The value of \f[B]seed\f[] will change after any use of the -\f[B]rand()\f[] and \f[B]irand(E)\f[] operands (see the -\f[I]Operands\f[] subsection below), except if the parameter passed to -\f[B]irand(E)\f[] is \f[B]0\f[], \f[B]1\f[], or negative. +The \f[I]scale\f[R] and sign of the value may be significant. +.PP +If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] +and used again, the pseudo-random number generator is guaranteed to +produce the same sequence of pseudo-random numbers as it did when the +\f[B]seed\f[R] value was previously used. +.PP +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if \f[B]seed\f[R] is queried again immediately. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will +\f[I]not\f[R] produce unique sequences of pseudo-random numbers. +The value of \f[B]seed\f[R] will change after any use of the +\f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the +\f[I]Operands\f[R] subsection below), except if the parameter passed to +\f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "14." 4 -\f[B]rand()\f[]: A pseudo\-random integer between \f[B]0\f[] (inclusive) -and \f[B]BC_RAND_MAX\f[] (inclusive). -Using this operand will change the value of \f[B]seed\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). +Using this operand will change the value of \f[B]seed\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "15." 4 -\f[B]irand(E)\f[]: A pseudo\-random integer between \f[B]0\f[] -(inclusive) and the value of \f[B]E\f[] (exclusive). -If \f[B]E\f[] is negative or is a non\-integer (\f[B]E\f[]\[aq]s -\f[I]scale\f[] is not \f[B]0\f[]), an error is raised, and bc(1) resets -(see the \f[B]RESET\f[] section) while \f[B]seed\f[] remains unchanged. -If \f[B]E\f[] is larger than \f[B]BC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]BC_RAND_MAX+1\f[], and adding them +\f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and the value of \f[B]E\f[R] (exclusive). +If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s +\f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) +resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains +unchanged. +If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. -Using this operand will change the value of \f[B]seed\f[], unless the -value of \f[B]E\f[] is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is returned, and \f[B]seed\f[] is \f[I]not\f[] -changed. -This is a \f[B]non\-portable extension\f[]. +Using this operand will change the value of \f[B]seed\f[R], unless the +value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is +\f[I]not\f[R] changed. +This is a \f[B]non-portable extension\f[R]. .IP "16." 4 -\f[B]maxrand()\f[]: The max integer returned by \f[B]rand()\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. +This is a \f[B]non-portable extension\f[R]. .PP -The integers generated by \f[B]rand()\f[] and \f[B]irand(E)\f[] are +The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of -the pseudo\-random number generator. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with \f[B]rand()\f[] and \f[B]irand(E)\f[] are guaranteed to -\f[I]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[I]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. +the pseudo-random number generator. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to +\f[I]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[I]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e\-3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -Using scientific notation is an error or warning if the \f[B]\-s\f[] or -\f[B]\-w\f[], respectively, command\-line options (or equivalents) are +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +Using scientific notation is an error or warning if the \f[B]-s\f[R] or +\f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and bc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if bc(1) is given the number string -\f[B]10e\-4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if bc(1) is given the number string +\f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP -Description: \f[B]truncation\f[] +Description: \f[B]truncation\f[R] .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]set precision\f[] +Description: \f[B]set precision\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]<<\f[] \f[B]>>\f[] +\f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]shift left\f[], \f[B]shift right\f[] +Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -673,270 +676,264 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] -The \f[B]truncation\f[] operator returns a copy of the given expression -with all of its \f[I]scale\f[] removed. +\f[B]$\f[R] +The \f[B]truncation\f[R] operator returns a copy of the given expression +with all of its \f[I]scale\f[R] removed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] -The \f[B]set precision\f[] operator takes two expressions and returns a -copy of the first with its \f[I]scale\f[] equal to the value of the +\f[B]\[at]\f[R] +The \f[B]set precision\f[R] operator takes two expressions and returns a +copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if -the \f[I]scale\f[] of the first expression matches the value of the +the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE -.TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. +.TP +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]<<\f[] -The \f[B]left shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the right. +\f[B]<<\f[R] +The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the right. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]>>\f[] -The \f[B]right shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the left. +\f[B]>>\f[R] +The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the left. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .PP -The \f[B]assignment\f[] operators that correspond to operators that are -extensions are themselves \f[B]non\-portable extensions\f[]. +The \f[B]assignment\f[R] operators that correspond to operators that are +extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[], and engineering notation is activated by assigning -\f[B]1\f[] to \f[B]obase\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R], and engineering notation is activated by assigning +\f[B]1\f[R] to \f[B]obase\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is -run with either the \f[B]\-s\f[] or \f[B]\-w\f[] command\-line options +run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -946,152 +943,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -1100,23 +1097,23 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math -library (see the \f[I]Extended Library\f[] subsection below), are -available when the \f[B]\-l\f[] or \f[B]\-\-mathlib\f[] command\-line +library (see the \f[I]Extended Library\f[R] subsection below), are +available when the \f[B]-l\f[R] or \f[B]\[en]mathlib\f[R] command-line flags are given, except that the extended math library is not available -when the \f[B]\-s\f[] option, the \f[B]\-w\f[] option, or equivalents +when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP @@ -1124,545 +1121,528 @@ The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Extended Library .PP -The extended library is \f[I]not\f[] loaded when the -\f[B]\-s\f[]/\f[B]\-\-standard\f[] or \f[B]\-w\f[]/\f[B]\-\-warn\f[] +The extended library is \f[I]not\f[R] loaded when the +\f[B]-s\f[R]/\f[B]\[en]standard\f[R] or \f[B]-w\f[R]/\f[B]\[en]warn\f[R] options are given since they are not part of the library defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html). .PP -The extended library is a \f[B]non\-portable extension\f[]. +The extended library is a \f[B]non-portable extension\f[R]. .TP -.B \f[B]p(x, y)\f[] -Calculates \f[B]x\f[] to the power of \f[B]y\f[], even if \f[B]y\f[] is -not an integer, and returns the result to the current \f[B]scale\f[]. +\f[B]p(x, y)\f[R] +Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] +is not an integer, and returns the result to the current +\f[B]scale\f[R]. .RS .PP +It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is +\f[B]0\f[R]. +.PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round half away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). -.RS -.RE +\f[B]r(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round half away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP -.B \f[B]ceil(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). -.RS -.RE +\f[B]ceil(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP -.B \f[B]f(x)\f[] -Returns the factorial of the truncated absolute value of \f[B]x\f[]. -.RS -.RE +\f[B]f(x)\f[R] +Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]perm(n, k)\f[] -Returns the permutation of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]perm(n, k)\f[R] +Returns the permutation of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]comb(n, k)\f[] -Returns the combination of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]comb(n, k)\f[R] +Returns the combination of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]l2(x)\f[] -Returns the logarithm base \f[B]2\f[] of \f[B]x\f[]. +\f[B]l2(x)\f[R] +Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l10(x)\f[] -Returns the logarithm base \f[B]10\f[] of \f[B]x\f[]. +\f[B]l10(x)\f[R] +Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]log(x, b)\f[] -Returns the logarithm base \f[B]b\f[] of \f[B]x\f[]. +\f[B]log(x, b)\f[R] +Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cbrt(x)\f[] -Returns the cube root of \f[B]x\f[]. -.RS -.RE +\f[B]cbrt(x)\f[R] +Returns the cube root of \f[B]x\f[R]. .TP -.B \f[B]root(x, n)\f[] -Calculates the truncated value of \f[B]n\f[], \f[B]r\f[], and returns -the \f[B]r\f[]th root of \f[B]x\f[] to the current \f[B]scale\f[]. +\f[B]root(x, n)\f[R] +Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns +the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP -If \f[B]r\f[] is \f[B]0\f[] or negative, this raises an error and causes -bc(1) to reset (see the \f[B]RESET\f[] section). -It also raises an error and causes bc(1) to reset if \f[B]r\f[] is even -and \f[B]x\f[] is negative. +If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and +causes bc(1) to reset (see the \f[B]RESET\f[R] section). +It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even +and \f[B]x\f[R] is negative. .RE .TP -.B \f[B]pi(p)\f[] -Returns \f[B]pi\f[] to \f[B]p\f[] decimal places. +\f[B]pi(p)\f[R] +Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]t(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]t(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]a2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]a2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]sin(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]sin(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]s(x)\f[]. +This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cos(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]cos(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]c(x)\f[]. +This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]tan(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]tan(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -If \f[B]x\f[] is equal to \f[B]1\f[] or \f[B]\-1\f[], this raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an +error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP -This is an alias of \f[B]t(x)\f[]. +This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]atan(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]atan(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP -This is an alias of \f[B]a(x)\f[]. +This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]atan2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]atan2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP -This is an alias of \f[B]a2(y, x)\f[]. +This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r2d(x)\f[] -Converts \f[B]x\f[] from radians to degrees and returns the result. +\f[B]r2d(x)\f[R] +Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]d2r(x)\f[] -Converts \f[B]x\f[] from degrees to radians and returns the result. +\f[B]d2r(x)\f[R] +Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]frand(p)\f[] -Generates a pseudo\-random number between \f[B]0\f[] (inclusive) and -\f[B]1\f[] (exclusive) with the number of decimal digits after the -decimal point equal to the truncated absolute value of \f[B]p\f[]. -If \f[B]p\f[] is not \f[B]0\f[], then calling this function will change -the value of \f[B]seed\f[]. -If \f[B]p\f[] is \f[B]0\f[], then \f[B]0\f[] is returned, and -\f[B]seed\f[] is \f[I]not\f[] changed. -.RS -.RE +\f[B]frand(p)\f[R] +Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and +\f[B]1\f[R] (exclusive) with the number of decimal digits after the +decimal point equal to the truncated absolute value of \f[B]p\f[R]. +If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will +change the value of \f[B]seed\f[R]. +If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and +\f[B]seed\f[R] is \f[I]not\f[R] changed. .TP -.B \f[B]ifrand(i, p)\f[] -Generates a pseudo\-random number that is between \f[B]0\f[] (inclusive) -and the truncated absolute value of \f[B]i\f[] (exclusive) with the +\f[B]ifrand(i, p)\f[R] +Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) +and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated -absolute value of \f[B]p\f[]. -If the absolute value of \f[B]i\f[] is greater than or equal to -\f[B]2\f[], and \f[B]p\f[] is not \f[B]0\f[], then calling this function -will change the value of \f[B]seed\f[]; otherwise, \f[B]0\f[] is -returned and \f[B]seed\f[] is not changed. -.RS -.RE +absolute value of \f[B]p\f[R]. +If the absolute value of \f[B]i\f[R] is greater than or equal to +\f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this +function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] +is returned and \f[B]seed\f[R] is not changed. .TP -.B \f[B]srand(x)\f[] -Returns \f[B]x\f[] with its sign flipped with probability \f[B]0.5\f[]. -In other words, it randomizes the sign of \f[B]x\f[]. -.RS -.RE +\f[B]srand(x)\f[R] +Returns \f[B]x\f[R] with its sign flipped with probability +\f[B]0.5\f[R]. +In other words, it randomizes the sign of \f[B]x\f[R]. .TP -.B \f[B]brand()\f[] -Returns a random boolean value (either \f[B]0\f[] or \f[B]1\f[]). -.RS -.RE +\f[B]brand()\f[R] +Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP -.B \f[B]ubytes(x)\f[] +\f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the -truncated absolute value of \f[B]x\f[]. -.RS -.RE +truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]sbytes(x)\f[] -Returns the numbers of signed, two\[aq]s\-complement integer bytes -required to hold the truncated value of \f[B]x\f[]. -.RS -.RE +\f[B]sbytes(x)\f[R] +Returns the numbers of signed, two\[cq]s-complement integer bytes +required to hold the truncated value of \f[B]x\f[R]. .TP -.B \f[B]hex(x)\f[] -Outputs the hexadecimal (base \f[B]16\f[]) representation of \f[B]x\f[]. +\f[B]hex(x)\f[R] +Outputs the hexadecimal (base \f[B]16\f[R]) representation of +\f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary(x)\f[] -Outputs the binary (base \f[B]2\f[]) representation of \f[B]x\f[]. +\f[B]binary(x)\f[R] +Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output(x, b)\f[] -Outputs the base \f[B]b\f[] representation of \f[B]x\f[]. +\f[B]output(x, b)\f[R] +Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as +\f[B]uint(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or is negative, an error message is -printed instead, but bc(1) is not reset (see the \f[B]RESET\f[] +If \f[B]x\f[R] is not an integer or is negative, an error message is +printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in as few power of two bytes as +\f[B]int(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, an error message is printed instead, -but bc(1) is not reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, an error message is printed instead, +but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uintn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]n\f[] bytes. +\f[B]uintn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]n\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]intn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]n\f[] bytes. +\f[B]intn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]n\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]1\f[] byte. +\f[B]uint8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]1\f[] byte, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]1\f[] byte. +\f[B]int8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]1\f[] byte, an +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]2\f[] bytes. +\f[B]uint16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]2\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]2\f[] bytes. +\f[B]int16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]2\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]4\f[] bytes. +\f[B]uint32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]4\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]4\f[] bytes. +\f[B]int32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]4\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]8\f[] bytes. +\f[B]uint64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]8\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]8\f[] bytes. +\f[B]int64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]8\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]hex_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in hexadecimal using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]hex_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] +bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in binary using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]binary_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in the current \f[B]obase\f[] (see the -\f[B]SYNTAX\f[] section) using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]output_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see +the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_byte(x, i)\f[] -Outputs byte \f[B]i\f[] of the truncated absolute value of \f[B]x\f[], -where \f[B]0\f[] is the least significant byte and \f[B]number_of_bytes -\- 1\f[] is the most significant byte. +\f[B]output_byte(x, i)\f[R] +Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], +where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes +- 1\f[R] is the most significant byte. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP @@ -1674,55 +1654,55 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 -\f[B]l2(x)\f[] +\f[B]l2(x)\f[R] .IP \[bu] 2 -\f[B]l10(x)\f[] +\f[B]l10(x)\f[R] .IP \[bu] 2 -\f[B]log(x, b)\f[] +\f[B]log(x, b)\f[R] .IP \[bu] 2 -\f[B]pi(p)\f[] +\f[B]pi(p)\f[R] .IP \[bu] 2 -\f[B]t(x)\f[] +\f[B]t(x)\f[R] .IP \[bu] 2 -\f[B]a2(y, x)\f[] +\f[B]a2(y, x)\f[R] .IP \[bu] 2 -\f[B]sin(x)\f[] +\f[B]sin(x)\f[R] .IP \[bu] 2 -\f[B]cos(x)\f[] +\f[B]cos(x)\f[R] .IP \[bu] 2 -\f[B]tan(x)\f[] +\f[B]tan(x)\f[R] .IP \[bu] 2 -\f[B]atan(x)\f[] +\f[B]atan(x)\f[R] .IP \[bu] 2 -\f[B]atan2(y, x)\f[] +\f[B]atan2(y, x)\f[R] .IP \[bu] 2 -\f[B]r2d(x)\f[] +\f[B]r2d(x)\f[R] .IP \[bu] 2 -\f[B]d2r(x)\f[] +\f[B]d2r(x)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1735,7 +1715,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1743,318 +1723,287 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]rand()\f[] operand. -Set at \f[B]2^BC_LONG_BIT\-1\f[]. -.RS -.RE +\f[B]BC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]rand()\f[R] +operand. +Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]<<\f[]), and -right shift (\f[B]>>\f[]) operators and their corresponding assignment -operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their +corresponding assignment operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGES\f[]. +locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it -supports \f[B]LC_MESSAGES\f[]. +supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP None are known. @@ -2062,4 +2011,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/HP.1.md b/contrib/bc/manuals/bc/HP.1.md index 2c4053a302d0..482f1a482734 100644 --- a/contrib/bc/manuals/bc/HP.1.md +++ b/contrib/bc/manuals/bc/HP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -411,9 +411,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **35**. In addition, bc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. @@ -576,7 +576,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -925,6 +925,8 @@ The extended library is a **non-portable extension**. : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. + It is an error if **y** is negative and **x** is **0**. + This is a transcendental function (see the *Transcendental Functions* subsection below). @@ -1658,7 +1660,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/N.1 b/contrib/bc/manuals/bc/N.1 index 5c3e86157ba7..9250b028635a 100644 --- a/contrib/bc/manuals/bc/N.1 +++ b/contrib/bc/manuals/bc/N.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,13 +46,13 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .PP -This bc(1) is a drop\-in replacement for \f[I]any\f[] bc(1), including +This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. @@ -58,9 +60,9 @@ implementations. .PP The following are the options that bc(1) accepts. .TP -.B \f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] -Turns the globals \f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], and -\f[B]seed\f[] into stacks. +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] +Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and +\f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are @@ -68,40 +70,40 @@ pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. -Thus, a hypothetical function named \f[B]output(x,b)\f[] that simply -printed \f[B]x\f[] in base \f[B]b\f[] could be written like this: +Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply +printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ obase=b -\ \ \ \ x +define void output(x, b) { + obase=b + x } -\f[] +\f[R] .fi .PP instead of like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ auto\ c -\ \ \ \ c=obase -\ \ \ \ obase=b -\ \ \ \ x -\ \ \ \ obase=c +define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c } -\f[] +\f[R] .fi .PP This makes writing functions much easier. .PP -(\f[B]Note\f[]: the function \f[B]output(x,b)\f[] exists in the extended -math library. -See the \f[B]LIBRARY\f[] section.) +(\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the +extended math library. +See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set -\f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] +\f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP @@ -112,118 +114,115 @@ Examples: .IP .nf \f[C] -alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" -\f[] +alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] +alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] +\f[R] .fi .PP -Second, if the purpose of a function is to set \f[B]ibase\f[], -\f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] globally for any other -purpose, it could be split into one to four functions (based on how many -globals it sets) and each of those functions could return the desired -value for a global. -.PP -For functions that set \f[B]seed\f[], the value assigned to -\f[B]seed\f[] is not propagated to parent functions. -This means that the sequence of pseudo\-random numbers that they see -will not be the same sequence of pseudo\-random numbers that any parent -sees. -This is only the case once \f[B]seed\f[] has been set. -.PP -If a function desires to not affect the sequence of pseudo\-random -numbers of its parents, but wants to use the same \f[B]seed\f[], it can +Second, if the purpose of a function is to set \f[B]ibase\f[R], +\f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any +other purpose, it could be split into one to four functions (based on +how many globals it sets) and each of those functions could return the +desired value for a global. +.PP +For functions that set \f[B]seed\f[R], the value assigned to +\f[B]seed\f[R] is not propagated to parent functions. +This means that the sequence of pseudo-random numbers that they see will +not be the same sequence of pseudo-random numbers that any parent sees. +This is only the case once \f[B]seed\f[R] has been set. +.PP +If a function desires to not affect the sequence of pseudo-random +numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] -seed\ =\ seed -\f[] +seed = seed +\f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then -users could make sure to define \f[B]BC_ENV_ARGS\f[] and include this -option (see the \f[B]ENVIRONMENT VARIABLES\f[] section for more +users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this +option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP -If \f[B]\-s\f[], \f[B]\-w\f[], or any equivalents are used, this option +If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library and the extended math library before +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP -To learn what is in the libraries, see the \f[B]LIBRARY\f[] section. +To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in bc(1). Most of those users would want to put this option in -\f[B]BC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT VARIABLES\f[] section). +\f[B]BC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT VARIABLES\f[R] section). .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -232,61 +231,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -294,388 +293,392 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]seed\f[] +\f[B]seed\f[R] .IP "7." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Numbers 6 and 7 are \f[B]non\-portable extensions\f[]. +Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP -The \f[I]scale\f[] and sign of the value may be significant. -.PP -If a previously used \f[B]seed\f[] value is assigned to \f[B]seed\f[] -and used again, the pseudo\-random number generator is guaranteed to -produce the same sequence of pseudo\-random numbers as it did when the -\f[B]seed\f[] value was previously used. -.PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if \f[B]seed\f[] is queried again immediately. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will -\f[I]not\f[] produce unique sequences of pseudo\-random numbers. -The value of \f[B]seed\f[] will change after any use of the -\f[B]rand()\f[] and \f[B]irand(E)\f[] operands (see the -\f[I]Operands\f[] subsection below), except if the parameter passed to -\f[B]irand(E)\f[] is \f[B]0\f[], \f[B]1\f[], or negative. +The \f[I]scale\f[R] and sign of the value may be significant. +.PP +If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] +and used again, the pseudo-random number generator is guaranteed to +produce the same sequence of pseudo-random numbers as it did when the +\f[B]seed\f[R] value was previously used. +.PP +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if \f[B]seed\f[R] is queried again immediately. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will +\f[I]not\f[R] produce unique sequences of pseudo-random numbers. +The value of \f[B]seed\f[R] will change after any use of the +\f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the +\f[I]Operands\f[R] subsection below), except if the parameter passed to +\f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "14." 4 -\f[B]rand()\f[]: A pseudo\-random integer between \f[B]0\f[] (inclusive) -and \f[B]BC_RAND_MAX\f[] (inclusive). -Using this operand will change the value of \f[B]seed\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). +Using this operand will change the value of \f[B]seed\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "15." 4 -\f[B]irand(E)\f[]: A pseudo\-random integer between \f[B]0\f[] -(inclusive) and the value of \f[B]E\f[] (exclusive). -If \f[B]E\f[] is negative or is a non\-integer (\f[B]E\f[]\[aq]s -\f[I]scale\f[] is not \f[B]0\f[]), an error is raised, and bc(1) resets -(see the \f[B]RESET\f[] section) while \f[B]seed\f[] remains unchanged. -If \f[B]E\f[] is larger than \f[B]BC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]BC_RAND_MAX+1\f[], and adding them +\f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and the value of \f[B]E\f[R] (exclusive). +If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s +\f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) +resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains +unchanged. +If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. -Using this operand will change the value of \f[B]seed\f[], unless the -value of \f[B]E\f[] is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is returned, and \f[B]seed\f[] is \f[I]not\f[] -changed. -This is a \f[B]non\-portable extension\f[]. +Using this operand will change the value of \f[B]seed\f[R], unless the +value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is +\f[I]not\f[R] changed. +This is a \f[B]non-portable extension\f[R]. .IP "16." 4 -\f[B]maxrand()\f[]: The max integer returned by \f[B]rand()\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. +This is a \f[B]non-portable extension\f[R]. .PP -The integers generated by \f[B]rand()\f[] and \f[B]irand(E)\f[] are +The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of -the pseudo\-random number generator. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with \f[B]rand()\f[] and \f[B]irand(E)\f[] are guaranteed to -\f[I]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[I]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. +the pseudo-random number generator. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to +\f[I]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[I]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e\-3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -Using scientific notation is an error or warning if the \f[B]\-s\f[] or -\f[B]\-w\f[], respectively, command\-line options (or equivalents) are +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +Using scientific notation is an error or warning if the \f[B]-s\f[R] or +\f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and bc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if bc(1) is given the number string -\f[B]10e\-4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if bc(1) is given the number string +\f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP -Description: \f[B]truncation\f[] +Description: \f[B]truncation\f[R] .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]set precision\f[] +Description: \f[B]set precision\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]<<\f[] \f[B]>>\f[] +\f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]shift left\f[], \f[B]shift right\f[] +Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -683,270 +686,264 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] -The \f[B]truncation\f[] operator returns a copy of the given expression -with all of its \f[I]scale\f[] removed. +\f[B]$\f[R] +The \f[B]truncation\f[R] operator returns a copy of the given expression +with all of its \f[I]scale\f[R] removed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] -The \f[B]set precision\f[] operator takes two expressions and returns a -copy of the first with its \f[I]scale\f[] equal to the value of the +\f[B]\[at]\f[R] +The \f[B]set precision\f[R] operator takes two expressions and returns a +copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if -the \f[I]scale\f[] of the first expression matches the value of the +the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE -.TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. +.TP +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]<<\f[] -The \f[B]left shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the right. +\f[B]<<\f[R] +The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the right. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]>>\f[] -The \f[B]right shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the left. +\f[B]>>\f[R] +The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the left. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .PP -The \f[B]assignment\f[] operators that correspond to operators that are -extensions are themselves \f[B]non\-portable extensions\f[]. +The \f[B]assignment\f[R] operators that correspond to operators that are +extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[], and engineering notation is activated by assigning -\f[B]1\f[] to \f[B]obase\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R], and engineering notation is activated by assigning +\f[B]1\f[R] to \f[B]obase\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is -run with either the \f[B]\-s\f[] or \f[B]\-w\f[] command\-line options +run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -956,152 +953,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -1110,23 +1107,23 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math -library (see the \f[I]Extended Library\f[] subsection below), are -available when the \f[B]\-l\f[] or \f[B]\-\-mathlib\f[] command\-line +library (see the \f[I]Extended Library\f[R] subsection below), are +available when the \f[B]-l\f[R] or \f[B]\[en]mathlib\f[R] command-line flags are given, except that the extended math library is not available -when the \f[B]\-s\f[] option, the \f[B]\-w\f[] option, or equivalents +when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP @@ -1134,545 +1131,528 @@ The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Extended Library .PP -The extended library is \f[I]not\f[] loaded when the -\f[B]\-s\f[]/\f[B]\-\-standard\f[] or \f[B]\-w\f[]/\f[B]\-\-warn\f[] +The extended library is \f[I]not\f[R] loaded when the +\f[B]-s\f[R]/\f[B]\[en]standard\f[R] or \f[B]-w\f[R]/\f[B]\[en]warn\f[R] options are given since they are not part of the library defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html). .PP -The extended library is a \f[B]non\-portable extension\f[]. +The extended library is a \f[B]non-portable extension\f[R]. .TP -.B \f[B]p(x, y)\f[] -Calculates \f[B]x\f[] to the power of \f[B]y\f[], even if \f[B]y\f[] is -not an integer, and returns the result to the current \f[B]scale\f[]. +\f[B]p(x, y)\f[R] +Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] +is not an integer, and returns the result to the current +\f[B]scale\f[R]. .RS .PP +It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is +\f[B]0\f[R]. +.PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round half away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). -.RS -.RE +\f[B]r(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round half away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP -.B \f[B]ceil(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). -.RS -.RE +\f[B]ceil(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP -.B \f[B]f(x)\f[] -Returns the factorial of the truncated absolute value of \f[B]x\f[]. -.RS -.RE +\f[B]f(x)\f[R] +Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]perm(n, k)\f[] -Returns the permutation of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]perm(n, k)\f[R] +Returns the permutation of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]comb(n, k)\f[] -Returns the combination of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]comb(n, k)\f[R] +Returns the combination of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]l2(x)\f[] -Returns the logarithm base \f[B]2\f[] of \f[B]x\f[]. +\f[B]l2(x)\f[R] +Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l10(x)\f[] -Returns the logarithm base \f[B]10\f[] of \f[B]x\f[]. +\f[B]l10(x)\f[R] +Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]log(x, b)\f[] -Returns the logarithm base \f[B]b\f[] of \f[B]x\f[]. +\f[B]log(x, b)\f[R] +Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cbrt(x)\f[] -Returns the cube root of \f[B]x\f[]. -.RS -.RE +\f[B]cbrt(x)\f[R] +Returns the cube root of \f[B]x\f[R]. .TP -.B \f[B]root(x, n)\f[] -Calculates the truncated value of \f[B]n\f[], \f[B]r\f[], and returns -the \f[B]r\f[]th root of \f[B]x\f[] to the current \f[B]scale\f[]. +\f[B]root(x, n)\f[R] +Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns +the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP -If \f[B]r\f[] is \f[B]0\f[] or negative, this raises an error and causes -bc(1) to reset (see the \f[B]RESET\f[] section). -It also raises an error and causes bc(1) to reset if \f[B]r\f[] is even -and \f[B]x\f[] is negative. +If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and +causes bc(1) to reset (see the \f[B]RESET\f[R] section). +It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even +and \f[B]x\f[R] is negative. .RE .TP -.B \f[B]pi(p)\f[] -Returns \f[B]pi\f[] to \f[B]p\f[] decimal places. +\f[B]pi(p)\f[R] +Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]t(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]t(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]a2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]a2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]sin(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]sin(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]s(x)\f[]. +This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cos(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]cos(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]c(x)\f[]. +This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]tan(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]tan(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -If \f[B]x\f[] is equal to \f[B]1\f[] or \f[B]\-1\f[], this raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an +error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP -This is an alias of \f[B]t(x)\f[]. +This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]atan(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]atan(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP -This is an alias of \f[B]a(x)\f[]. +This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]atan2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]atan2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP -This is an alias of \f[B]a2(y, x)\f[]. +This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r2d(x)\f[] -Converts \f[B]x\f[] from radians to degrees and returns the result. +\f[B]r2d(x)\f[R] +Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]d2r(x)\f[] -Converts \f[B]x\f[] from degrees to radians and returns the result. +\f[B]d2r(x)\f[R] +Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]frand(p)\f[] -Generates a pseudo\-random number between \f[B]0\f[] (inclusive) and -\f[B]1\f[] (exclusive) with the number of decimal digits after the -decimal point equal to the truncated absolute value of \f[B]p\f[]. -If \f[B]p\f[] is not \f[B]0\f[], then calling this function will change -the value of \f[B]seed\f[]. -If \f[B]p\f[] is \f[B]0\f[], then \f[B]0\f[] is returned, and -\f[B]seed\f[] is \f[I]not\f[] changed. -.RS -.RE +\f[B]frand(p)\f[R] +Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and +\f[B]1\f[R] (exclusive) with the number of decimal digits after the +decimal point equal to the truncated absolute value of \f[B]p\f[R]. +If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will +change the value of \f[B]seed\f[R]. +If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and +\f[B]seed\f[R] is \f[I]not\f[R] changed. .TP -.B \f[B]ifrand(i, p)\f[] -Generates a pseudo\-random number that is between \f[B]0\f[] (inclusive) -and the truncated absolute value of \f[B]i\f[] (exclusive) with the +\f[B]ifrand(i, p)\f[R] +Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) +and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated -absolute value of \f[B]p\f[]. -If the absolute value of \f[B]i\f[] is greater than or equal to -\f[B]2\f[], and \f[B]p\f[] is not \f[B]0\f[], then calling this function -will change the value of \f[B]seed\f[]; otherwise, \f[B]0\f[] is -returned and \f[B]seed\f[] is not changed. -.RS -.RE +absolute value of \f[B]p\f[R]. +If the absolute value of \f[B]i\f[R] is greater than or equal to +\f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this +function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] +is returned and \f[B]seed\f[R] is not changed. .TP -.B \f[B]srand(x)\f[] -Returns \f[B]x\f[] with its sign flipped with probability \f[B]0.5\f[]. -In other words, it randomizes the sign of \f[B]x\f[]. -.RS -.RE +\f[B]srand(x)\f[R] +Returns \f[B]x\f[R] with its sign flipped with probability +\f[B]0.5\f[R]. +In other words, it randomizes the sign of \f[B]x\f[R]. .TP -.B \f[B]brand()\f[] -Returns a random boolean value (either \f[B]0\f[] or \f[B]1\f[]). -.RS -.RE +\f[B]brand()\f[R] +Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP -.B \f[B]ubytes(x)\f[] +\f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the -truncated absolute value of \f[B]x\f[]. -.RS -.RE +truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]sbytes(x)\f[] -Returns the numbers of signed, two\[aq]s\-complement integer bytes -required to hold the truncated value of \f[B]x\f[]. -.RS -.RE +\f[B]sbytes(x)\f[R] +Returns the numbers of signed, two\[cq]s-complement integer bytes +required to hold the truncated value of \f[B]x\f[R]. .TP -.B \f[B]hex(x)\f[] -Outputs the hexadecimal (base \f[B]16\f[]) representation of \f[B]x\f[]. +\f[B]hex(x)\f[R] +Outputs the hexadecimal (base \f[B]16\f[R]) representation of +\f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary(x)\f[] -Outputs the binary (base \f[B]2\f[]) representation of \f[B]x\f[]. +\f[B]binary(x)\f[R] +Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output(x, b)\f[] -Outputs the base \f[B]b\f[] representation of \f[B]x\f[]. +\f[B]output(x, b)\f[R] +Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as +\f[B]uint(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or is negative, an error message is -printed instead, but bc(1) is not reset (see the \f[B]RESET\f[] +If \f[B]x\f[R] is not an integer or is negative, an error message is +printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in as few power of two bytes as +\f[B]int(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, an error message is printed instead, -but bc(1) is not reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, an error message is printed instead, +but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uintn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]n\f[] bytes. +\f[B]uintn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]n\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]intn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]n\f[] bytes. +\f[B]intn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]n\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]1\f[] byte. +\f[B]uint8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]1\f[] byte, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]1\f[] byte. +\f[B]int8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]1\f[] byte, an +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]2\f[] bytes. +\f[B]uint16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]2\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]2\f[] bytes. +\f[B]int16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]2\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]4\f[] bytes. +\f[B]uint32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]4\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]4\f[] bytes. +\f[B]int32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]4\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]8\f[] bytes. +\f[B]uint64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]8\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]8\f[] bytes. +\f[B]int64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]8\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]hex_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in hexadecimal using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]hex_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] +bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in binary using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]binary_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in the current \f[B]obase\f[] (see the -\f[B]SYNTAX\f[] section) using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]output_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see +the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_byte(x, i)\f[] -Outputs byte \f[B]i\f[] of the truncated absolute value of \f[B]x\f[], -where \f[B]0\f[] is the least significant byte and \f[B]number_of_bytes -\- 1\f[] is the most significant byte. +\f[B]output_byte(x, i)\f[R] +Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], +where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes +- 1\f[R] is the most significant byte. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP @@ -1684,55 +1664,55 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 -\f[B]l2(x)\f[] +\f[B]l2(x)\f[R] .IP \[bu] 2 -\f[B]l10(x)\f[] +\f[B]l10(x)\f[R] .IP \[bu] 2 -\f[B]log(x, b)\f[] +\f[B]log(x, b)\f[R] .IP \[bu] 2 -\f[B]pi(p)\f[] +\f[B]pi(p)\f[R] .IP \[bu] 2 -\f[B]t(x)\f[] +\f[B]t(x)\f[R] .IP \[bu] 2 -\f[B]a2(y, x)\f[] +\f[B]a2(y, x)\f[R] .IP \[bu] 2 -\f[B]sin(x)\f[] +\f[B]sin(x)\f[R] .IP \[bu] 2 -\f[B]cos(x)\f[] +\f[B]cos(x)\f[R] .IP \[bu] 2 -\f[B]tan(x)\f[] +\f[B]tan(x)\f[R] .IP \[bu] 2 -\f[B]atan(x)\f[] +\f[B]atan(x)\f[R] .IP \[bu] 2 -\f[B]atan2(y, x)\f[] +\f[B]atan2(y, x)\f[R] .IP \[bu] 2 -\f[B]r2d(x)\f[] +\f[B]r2d(x)\f[R] .IP \[bu] 2 -\f[B]d2r(x)\f[] +\f[B]d2r(x)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1745,7 +1725,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1753,269 +1733,238 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]rand()\f[] operand. -Set at \f[B]2^BC_LONG_BIT\-1\f[]. -.RS -.RE +\f[B]BC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]rand()\f[R] +operand. +Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]<<\f[]), and -right shift (\f[B]>>\f[]) operators and their corresponding assignment -operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their +corresponding assignment operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP The prompt is enabled in TTY mode. @@ -2023,58 +1972,58 @@ The prompt is enabled in TTY mode. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when bc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause bc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when bc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -bc(1) supports interactive command\-line editing. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +bc(1) supports interactive command-line editing. +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP None are known. @@ -2082,4 +2031,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/N.1.md b/contrib/bc/manuals/bc/N.1.md index 9eabb2591eab..63a5acf8ab47 100644 --- a/contrib/bc/manuals/bc/N.1.md +++ b/contrib/bc/manuals/bc/N.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -419,9 +419,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **35**. In addition, bc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. @@ -584,7 +584,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -933,6 +933,8 @@ The extended library is a **non-portable extension**. : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. + It is an error if **y** is negative and **x** is **0**. + This is a transcendental function (see the *Transcendental Functions* subsection below). @@ -1673,7 +1675,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/NP.1 b/contrib/bc/manuals/bc/NP.1 index 8c2a2994a17f..89377821b179 100644 --- a/contrib/bc/manuals/bc/NP.1 +++ b/contrib/bc/manuals/bc/NP.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,13 +46,13 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .PP -This bc(1) is a drop\-in replacement for \f[I]any\f[] bc(1), including +This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. @@ -58,9 +60,9 @@ implementations. .PP The following are the options that bc(1) accepts. .TP -.B \f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] -Turns the globals \f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], and -\f[B]seed\f[] into stacks. +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] +Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and +\f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are @@ -68,40 +70,40 @@ pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. -Thus, a hypothetical function named \f[B]output(x,b)\f[] that simply -printed \f[B]x\f[] in base \f[B]b\f[] could be written like this: +Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply +printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ obase=b -\ \ \ \ x +define void output(x, b) { + obase=b + x } -\f[] +\f[R] .fi .PP instead of like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ auto\ c -\ \ \ \ c=obase -\ \ \ \ obase=b -\ \ \ \ x -\ \ \ \ obase=c +define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c } -\f[] +\f[R] .fi .PP This makes writing functions much easier. .PP -(\f[B]Note\f[]: the function \f[B]output(x,b)\f[] exists in the extended -math library. -See the \f[B]LIBRARY\f[] section.) +(\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the +extended math library. +See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set -\f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] +\f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP @@ -112,113 +114,110 @@ Examples: .IP .nf \f[C] -alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" -\f[] +alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] +alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] +\f[R] .fi .PP -Second, if the purpose of a function is to set \f[B]ibase\f[], -\f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] globally for any other -purpose, it could be split into one to four functions (based on how many -globals it sets) and each of those functions could return the desired -value for a global. -.PP -For functions that set \f[B]seed\f[], the value assigned to -\f[B]seed\f[] is not propagated to parent functions. -This means that the sequence of pseudo\-random numbers that they see -will not be the same sequence of pseudo\-random numbers that any parent -sees. -This is only the case once \f[B]seed\f[] has been set. -.PP -If a function desires to not affect the sequence of pseudo\-random -numbers of its parents, but wants to use the same \f[B]seed\f[], it can +Second, if the purpose of a function is to set \f[B]ibase\f[R], +\f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any +other purpose, it could be split into one to four functions (based on +how many globals it sets) and each of those functions could return the +desired value for a global. +.PP +For functions that set \f[B]seed\f[R], the value assigned to +\f[B]seed\f[R] is not propagated to parent functions. +This means that the sequence of pseudo-random numbers that they see will +not be the same sequence of pseudo-random numbers that any parent sees. +This is only the case once \f[B]seed\f[R] has been set. +.PP +If a function desires to not affect the sequence of pseudo-random +numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] -seed\ =\ seed -\f[] +seed = seed +\f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then -users could make sure to define \f[B]BC_ENV_ARGS\f[] and include this -option (see the \f[B]ENVIRONMENT VARIABLES\f[] section for more +users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this +option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP -If \f[B]\-s\f[], \f[B]\-w\f[], or any equivalents are used, this option +If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library and the extended math library before +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP -To learn what is in the libraries, see the \f[B]LIBRARY\f[] section. +To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -227,61 +226,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -289,388 +288,392 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]seed\f[] +\f[B]seed\f[R] .IP "7." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Numbers 6 and 7 are \f[B]non\-portable extensions\f[]. +Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP -The \f[I]scale\f[] and sign of the value may be significant. -.PP -If a previously used \f[B]seed\f[] value is assigned to \f[B]seed\f[] -and used again, the pseudo\-random number generator is guaranteed to -produce the same sequence of pseudo\-random numbers as it did when the -\f[B]seed\f[] value was previously used. -.PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if \f[B]seed\f[] is queried again immediately. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will -\f[I]not\f[] produce unique sequences of pseudo\-random numbers. -The value of \f[B]seed\f[] will change after any use of the -\f[B]rand()\f[] and \f[B]irand(E)\f[] operands (see the -\f[I]Operands\f[] subsection below), except if the parameter passed to -\f[B]irand(E)\f[] is \f[B]0\f[], \f[B]1\f[], or negative. +The \f[I]scale\f[R] and sign of the value may be significant. +.PP +If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] +and used again, the pseudo-random number generator is guaranteed to +produce the same sequence of pseudo-random numbers as it did when the +\f[B]seed\f[R] value was previously used. +.PP +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if \f[B]seed\f[R] is queried again immediately. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will +\f[I]not\f[R] produce unique sequences of pseudo-random numbers. +The value of \f[B]seed\f[R] will change after any use of the +\f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the +\f[I]Operands\f[R] subsection below), except if the parameter passed to +\f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "14." 4 -\f[B]rand()\f[]: A pseudo\-random integer between \f[B]0\f[] (inclusive) -and \f[B]BC_RAND_MAX\f[] (inclusive). -Using this operand will change the value of \f[B]seed\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). +Using this operand will change the value of \f[B]seed\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "15." 4 -\f[B]irand(E)\f[]: A pseudo\-random integer between \f[B]0\f[] -(inclusive) and the value of \f[B]E\f[] (exclusive). -If \f[B]E\f[] is negative or is a non\-integer (\f[B]E\f[]\[aq]s -\f[I]scale\f[] is not \f[B]0\f[]), an error is raised, and bc(1) resets -(see the \f[B]RESET\f[] section) while \f[B]seed\f[] remains unchanged. -If \f[B]E\f[] is larger than \f[B]BC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]BC_RAND_MAX+1\f[], and adding them +\f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and the value of \f[B]E\f[R] (exclusive). +If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s +\f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) +resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains +unchanged. +If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. -Using this operand will change the value of \f[B]seed\f[], unless the -value of \f[B]E\f[] is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is returned, and \f[B]seed\f[] is \f[I]not\f[] -changed. -This is a \f[B]non\-portable extension\f[]. +Using this operand will change the value of \f[B]seed\f[R], unless the +value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is +\f[I]not\f[R] changed. +This is a \f[B]non-portable extension\f[R]. .IP "16." 4 -\f[B]maxrand()\f[]: The max integer returned by \f[B]rand()\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. +This is a \f[B]non-portable extension\f[R]. .PP -The integers generated by \f[B]rand()\f[] and \f[B]irand(E)\f[] are +The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of -the pseudo\-random number generator. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with \f[B]rand()\f[] and \f[B]irand(E)\f[] are guaranteed to -\f[I]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[I]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. +the pseudo-random number generator. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to +\f[I]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[I]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e\-3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -Using scientific notation is an error or warning if the \f[B]\-s\f[] or -\f[B]\-w\f[], respectively, command\-line options (or equivalents) are +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +Using scientific notation is an error or warning if the \f[B]-s\f[R] or +\f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and bc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if bc(1) is given the number string -\f[B]10e\-4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if bc(1) is given the number string +\f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP -Description: \f[B]truncation\f[] +Description: \f[B]truncation\f[R] .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]set precision\f[] +Description: \f[B]set precision\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]<<\f[] \f[B]>>\f[] +\f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]shift left\f[], \f[B]shift right\f[] +Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -678,270 +681,264 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] -The \f[B]truncation\f[] operator returns a copy of the given expression -with all of its \f[I]scale\f[] removed. +\f[B]$\f[R] +The \f[B]truncation\f[R] operator returns a copy of the given expression +with all of its \f[I]scale\f[R] removed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] -The \f[B]set precision\f[] operator takes two expressions and returns a -copy of the first with its \f[I]scale\f[] equal to the value of the +\f[B]\[at]\f[R] +The \f[B]set precision\f[R] operator takes two expressions and returns a +copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if -the \f[I]scale\f[] of the first expression matches the value of the +the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE -.TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. +.TP +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]<<\f[] -The \f[B]left shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the right. +\f[B]<<\f[R] +The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the right. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]>>\f[] -The \f[B]right shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the left. +\f[B]>>\f[R] +The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the left. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .PP -The \f[B]assignment\f[] operators that correspond to operators that are -extensions are themselves \f[B]non\-portable extensions\f[]. +The \f[B]assignment\f[R] operators that correspond to operators that are +extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[], and engineering notation is activated by assigning -\f[B]1\f[] to \f[B]obase\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R], and engineering notation is activated by assigning +\f[B]1\f[R] to \f[B]obase\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is -run with either the \f[B]\-s\f[] or \f[B]\-w\f[] command\-line options +run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -951,152 +948,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -1105,23 +1102,23 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math -library (see the \f[I]Extended Library\f[] subsection below), are -available when the \f[B]\-l\f[] or \f[B]\-\-mathlib\f[] command\-line +library (see the \f[I]Extended Library\f[R] subsection below), are +available when the \f[B]-l\f[R] or \f[B]\[en]mathlib\f[R] command-line flags are given, except that the extended math library is not available -when the \f[B]\-s\f[] option, the \f[B]\-w\f[] option, or equivalents +when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP @@ -1129,545 +1126,528 @@ The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Extended Library .PP -The extended library is \f[I]not\f[] loaded when the -\f[B]\-s\f[]/\f[B]\-\-standard\f[] or \f[B]\-w\f[]/\f[B]\-\-warn\f[] +The extended library is \f[I]not\f[R] loaded when the +\f[B]-s\f[R]/\f[B]\[en]standard\f[R] or \f[B]-w\f[R]/\f[B]\[en]warn\f[R] options are given since they are not part of the library defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html). .PP -The extended library is a \f[B]non\-portable extension\f[]. +The extended library is a \f[B]non-portable extension\f[R]. .TP -.B \f[B]p(x, y)\f[] -Calculates \f[B]x\f[] to the power of \f[B]y\f[], even if \f[B]y\f[] is -not an integer, and returns the result to the current \f[B]scale\f[]. +\f[B]p(x, y)\f[R] +Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] +is not an integer, and returns the result to the current +\f[B]scale\f[R]. .RS .PP +It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is +\f[B]0\f[R]. +.PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round half away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). -.RS -.RE +\f[B]r(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round half away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP -.B \f[B]ceil(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). -.RS -.RE +\f[B]ceil(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP -.B \f[B]f(x)\f[] -Returns the factorial of the truncated absolute value of \f[B]x\f[]. -.RS -.RE +\f[B]f(x)\f[R] +Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]perm(n, k)\f[] -Returns the permutation of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]perm(n, k)\f[R] +Returns the permutation of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]comb(n, k)\f[] -Returns the combination of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]comb(n, k)\f[R] +Returns the combination of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]l2(x)\f[] -Returns the logarithm base \f[B]2\f[] of \f[B]x\f[]. +\f[B]l2(x)\f[R] +Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l10(x)\f[] -Returns the logarithm base \f[B]10\f[] of \f[B]x\f[]. +\f[B]l10(x)\f[R] +Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]log(x, b)\f[] -Returns the logarithm base \f[B]b\f[] of \f[B]x\f[]. +\f[B]log(x, b)\f[R] +Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cbrt(x)\f[] -Returns the cube root of \f[B]x\f[]. -.RS -.RE +\f[B]cbrt(x)\f[R] +Returns the cube root of \f[B]x\f[R]. .TP -.B \f[B]root(x, n)\f[] -Calculates the truncated value of \f[B]n\f[], \f[B]r\f[], and returns -the \f[B]r\f[]th root of \f[B]x\f[] to the current \f[B]scale\f[]. +\f[B]root(x, n)\f[R] +Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns +the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP -If \f[B]r\f[] is \f[B]0\f[] or negative, this raises an error and causes -bc(1) to reset (see the \f[B]RESET\f[] section). -It also raises an error and causes bc(1) to reset if \f[B]r\f[] is even -and \f[B]x\f[] is negative. +If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and +causes bc(1) to reset (see the \f[B]RESET\f[R] section). +It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even +and \f[B]x\f[R] is negative. .RE .TP -.B \f[B]pi(p)\f[] -Returns \f[B]pi\f[] to \f[B]p\f[] decimal places. +\f[B]pi(p)\f[R] +Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]t(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]t(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]a2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]a2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]sin(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]sin(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]s(x)\f[]. +This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cos(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]cos(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]c(x)\f[]. +This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]tan(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]tan(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -If \f[B]x\f[] is equal to \f[B]1\f[] or \f[B]\-1\f[], this raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an +error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP -This is an alias of \f[B]t(x)\f[]. +This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]atan(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]atan(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP -This is an alias of \f[B]a(x)\f[]. +This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]atan2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]atan2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP -This is an alias of \f[B]a2(y, x)\f[]. +This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r2d(x)\f[] -Converts \f[B]x\f[] from radians to degrees and returns the result. +\f[B]r2d(x)\f[R] +Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]d2r(x)\f[] -Converts \f[B]x\f[] from degrees to radians and returns the result. +\f[B]d2r(x)\f[R] +Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]frand(p)\f[] -Generates a pseudo\-random number between \f[B]0\f[] (inclusive) and -\f[B]1\f[] (exclusive) with the number of decimal digits after the -decimal point equal to the truncated absolute value of \f[B]p\f[]. -If \f[B]p\f[] is not \f[B]0\f[], then calling this function will change -the value of \f[B]seed\f[]. -If \f[B]p\f[] is \f[B]0\f[], then \f[B]0\f[] is returned, and -\f[B]seed\f[] is \f[I]not\f[] changed. -.RS -.RE +\f[B]frand(p)\f[R] +Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and +\f[B]1\f[R] (exclusive) with the number of decimal digits after the +decimal point equal to the truncated absolute value of \f[B]p\f[R]. +If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will +change the value of \f[B]seed\f[R]. +If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and +\f[B]seed\f[R] is \f[I]not\f[R] changed. .TP -.B \f[B]ifrand(i, p)\f[] -Generates a pseudo\-random number that is between \f[B]0\f[] (inclusive) -and the truncated absolute value of \f[B]i\f[] (exclusive) with the +\f[B]ifrand(i, p)\f[R] +Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) +and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated -absolute value of \f[B]p\f[]. -If the absolute value of \f[B]i\f[] is greater than or equal to -\f[B]2\f[], and \f[B]p\f[] is not \f[B]0\f[], then calling this function -will change the value of \f[B]seed\f[]; otherwise, \f[B]0\f[] is -returned and \f[B]seed\f[] is not changed. -.RS -.RE +absolute value of \f[B]p\f[R]. +If the absolute value of \f[B]i\f[R] is greater than or equal to +\f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this +function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] +is returned and \f[B]seed\f[R] is not changed. .TP -.B \f[B]srand(x)\f[] -Returns \f[B]x\f[] with its sign flipped with probability \f[B]0.5\f[]. -In other words, it randomizes the sign of \f[B]x\f[]. -.RS -.RE +\f[B]srand(x)\f[R] +Returns \f[B]x\f[R] with its sign flipped with probability +\f[B]0.5\f[R]. +In other words, it randomizes the sign of \f[B]x\f[R]. .TP -.B \f[B]brand()\f[] -Returns a random boolean value (either \f[B]0\f[] or \f[B]1\f[]). -.RS -.RE +\f[B]brand()\f[R] +Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP -.B \f[B]ubytes(x)\f[] +\f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the -truncated absolute value of \f[B]x\f[]. -.RS -.RE +truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]sbytes(x)\f[] -Returns the numbers of signed, two\[aq]s\-complement integer bytes -required to hold the truncated value of \f[B]x\f[]. -.RS -.RE +\f[B]sbytes(x)\f[R] +Returns the numbers of signed, two\[cq]s-complement integer bytes +required to hold the truncated value of \f[B]x\f[R]. .TP -.B \f[B]hex(x)\f[] -Outputs the hexadecimal (base \f[B]16\f[]) representation of \f[B]x\f[]. +\f[B]hex(x)\f[R] +Outputs the hexadecimal (base \f[B]16\f[R]) representation of +\f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary(x)\f[] -Outputs the binary (base \f[B]2\f[]) representation of \f[B]x\f[]. +\f[B]binary(x)\f[R] +Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output(x, b)\f[] -Outputs the base \f[B]b\f[] representation of \f[B]x\f[]. +\f[B]output(x, b)\f[R] +Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as +\f[B]uint(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or is negative, an error message is -printed instead, but bc(1) is not reset (see the \f[B]RESET\f[] +If \f[B]x\f[R] is not an integer or is negative, an error message is +printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in as few power of two bytes as +\f[B]int(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, an error message is printed instead, -but bc(1) is not reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, an error message is printed instead, +but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uintn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]n\f[] bytes. +\f[B]uintn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]n\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]intn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]n\f[] bytes. +\f[B]intn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]n\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]1\f[] byte. +\f[B]uint8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]1\f[] byte, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]1\f[] byte. +\f[B]int8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]1\f[] byte, an +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]2\f[] bytes. +\f[B]uint16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]2\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]2\f[] bytes. +\f[B]int16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]2\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]4\f[] bytes. +\f[B]uint32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]4\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]4\f[] bytes. +\f[B]int32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]4\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]8\f[] bytes. +\f[B]uint64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]8\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]8\f[] bytes. +\f[B]int64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]8\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]hex_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in hexadecimal using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]hex_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] +bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in binary using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]binary_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in the current \f[B]obase\f[] (see the -\f[B]SYNTAX\f[] section) using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]output_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see +the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_byte(x, i)\f[] -Outputs byte \f[B]i\f[] of the truncated absolute value of \f[B]x\f[], -where \f[B]0\f[] is the least significant byte and \f[B]number_of_bytes -\- 1\f[] is the most significant byte. +\f[B]output_byte(x, i)\f[R] +Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], +where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes +- 1\f[R] is the most significant byte. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP @@ -1679,55 +1659,55 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 -\f[B]l2(x)\f[] +\f[B]l2(x)\f[R] .IP \[bu] 2 -\f[B]l10(x)\f[] +\f[B]l10(x)\f[R] .IP \[bu] 2 -\f[B]log(x, b)\f[] +\f[B]log(x, b)\f[R] .IP \[bu] 2 -\f[B]pi(p)\f[] +\f[B]pi(p)\f[R] .IP \[bu] 2 -\f[B]t(x)\f[] +\f[B]t(x)\f[R] .IP \[bu] 2 -\f[B]a2(y, x)\f[] +\f[B]a2(y, x)\f[R] .IP \[bu] 2 -\f[B]sin(x)\f[] +\f[B]sin(x)\f[R] .IP \[bu] 2 -\f[B]cos(x)\f[] +\f[B]cos(x)\f[R] .IP \[bu] 2 -\f[B]tan(x)\f[] +\f[B]tan(x)\f[R] .IP \[bu] 2 -\f[B]atan(x)\f[] +\f[B]atan(x)\f[R] .IP \[bu] 2 -\f[B]atan2(y, x)\f[] +\f[B]atan2(y, x)\f[R] .IP \[bu] 2 -\f[B]r2d(x)\f[] +\f[B]r2d(x)\f[R] .IP \[bu] 2 -\f[B]d2r(x)\f[] +\f[B]d2r(x)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1740,7 +1720,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1748,326 +1728,295 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]rand()\f[] operand. -Set at \f[B]2^BC_LONG_BIT\-1\f[]. -.RS -.RE +\f[B]BC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]rand()\f[R] +operand. +Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]<<\f[]), and -right shift (\f[B]>>\f[]) operators and their corresponding assignment -operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their +corresponding assignment operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when bc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause bc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when bc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -bc(1) supports interactive command\-line editing. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +bc(1) supports interactive command-line editing. +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .SH BUGS .PP None are known. @@ -2075,4 +2024,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/NP.1.md b/contrib/bc/manuals/bc/NP.1.md index be11fe236209..60d6a7e59b37 100644 --- a/contrib/bc/manuals/bc/NP.1.md +++ b/contrib/bc/manuals/bc/NP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -415,9 +415,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **35**. In addition, bc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. @@ -580,7 +580,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -929,6 +929,8 @@ The extended library is a **non-portable extension**. : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. + It is an error if **y** is negative and **x** is **0**. + This is a transcendental function (see the *Transcendental Functions* subsection below). @@ -1667,7 +1669,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bc/P.1 b/contrib/bc/manuals/bc/P.1 index db807e440c28..688d6cb612b3 100644 --- a/contrib/bc/manuals/bc/P.1 +++ b/contrib/bc/manuals/bc/P.1 @@ -25,18 +25,20 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "BC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH NAME .PP -bc \- arbitrary\-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator .SH SYNOPSIS .PP -\f[B]bc\f[] [\f[B]\-ghilPqsvVw\f[]] [\f[B]\-\-global\-stacks\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-mathlib\f[]] -[\f[B]\-\-no\-prompt\f[]] [\f[B]\-\-quiet\f[]] [\f[B]\-\-standard\f[]] -[\f[B]\-\-warn\f[]] [\f[B]\-\-version\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]bc\f[R] [\f[B]-ghilPqsvVw\f[R]] [\f[B]\[en]global-stacks\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]mathlib\f[R]] [\f[B]\[en]no-prompt\f[R]] +[\f[B]\[en]quiet\f[R]] [\f[B]\[en]standard\f[R]] [\f[B]\[en]warn\f[R]] +[\f[B]\[en]version\f[R]] [\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP bc(1) is an interactive processor for a language first standardized in @@ -44,13 +46,13 @@ bc(1) is an interactive processor for a language first standardized in (The current standard is here (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html).) The language provides unlimited precision decimal arithmetic and is -somewhat C\-like, but there are differences. +somewhat C-like, but there are differences. Such differences will be noted in this document. .PP After parsing and handling options, this bc(1) reads any files given on -the command line and executes them before reading from \f[B]stdin\f[]. +the command line and executes them before reading from \f[B]stdin\f[R]. .PP -This bc(1) is a drop\-in replacement for \f[I]any\f[] bc(1), including +This bc(1) is a drop-in replacement for \f[I]any\f[R] bc(1), including (and especially) the GNU bc(1). It also has many extensions and extra features beyond other implementations. @@ -58,9 +60,9 @@ implementations. .PP The following are the options that bc(1) accepts. .TP -.B \f[B]\-g\f[], \f[B]\-\-global\-stacks\f[] -Turns the globals \f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], and -\f[B]seed\f[] into stacks. +\f[B]-g\f[R], \f[B]\[en]global-stacks\f[R] +Turns the globals \f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], and +\f[B]seed\f[R] into stacks. .RS .PP This has the effect that a copy of the current value of all four are @@ -68,40 +70,40 @@ pushed onto a stack for every function call, as well as popped when every function returns. This means that functions can assign to any and all of those globals without worrying that the change will affect other functions. -Thus, a hypothetical function named \f[B]output(x,b)\f[] that simply -printed \f[B]x\f[] in base \f[B]b\f[] could be written like this: +Thus, a hypothetical function named \f[B]output(x,b)\f[R] that simply +printed \f[B]x\f[R] in base \f[B]b\f[R] could be written like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ obase=b -\ \ \ \ x +define void output(x, b) { + obase=b + x } -\f[] +\f[R] .fi .PP instead of like this: .IP .nf \f[C] -define\ void\ output(x,\ b)\ { -\ \ \ \ auto\ c -\ \ \ \ c=obase -\ \ \ \ obase=b -\ \ \ \ x -\ \ \ \ obase=c +define void output(x, b) { + auto c + c=obase + obase=b + x + obase=c } -\f[] +\f[R] .fi .PP This makes writing functions much easier. .PP -(\f[B]Note\f[]: the function \f[B]output(x,b)\f[] exists in the extended -math library. -See the \f[B]LIBRARY\f[] section.) +(\f[B]Note\f[R]: the function \f[B]output(x,b)\f[R] exists in the +extended math library. +See the \f[B]LIBRARY\f[R] section.) .PP However, since using this flag means that functions cannot set -\f[B]ibase\f[], \f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] +\f[B]ibase\f[R], \f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally, functions that are made to do so cannot work anymore. There are two possible use cases for that, and each has a solution. .PP @@ -112,113 +114,110 @@ Examples: .IP .nf \f[C] -alias\ d2o="bc\ \-e\ ibase=A\ \-e\ obase=8" -alias\ h2b="bc\ \-e\ ibase=G\ \-e\ obase=2" -\f[] +alias d2o=\[dq]bc -e ibase=A -e obase=8\[dq] +alias h2b=\[dq]bc -e ibase=G -e obase=2\[dq] +\f[R] .fi .PP -Second, if the purpose of a function is to set \f[B]ibase\f[], -\f[B]obase\f[], \f[B]scale\f[], or \f[B]seed\f[] globally for any other -purpose, it could be split into one to four functions (based on how many -globals it sets) and each of those functions could return the desired -value for a global. -.PP -For functions that set \f[B]seed\f[], the value assigned to -\f[B]seed\f[] is not propagated to parent functions. -This means that the sequence of pseudo\-random numbers that they see -will not be the same sequence of pseudo\-random numbers that any parent -sees. -This is only the case once \f[B]seed\f[] has been set. -.PP -If a function desires to not affect the sequence of pseudo\-random -numbers of its parents, but wants to use the same \f[B]seed\f[], it can +Second, if the purpose of a function is to set \f[B]ibase\f[R], +\f[B]obase\f[R], \f[B]scale\f[R], or \f[B]seed\f[R] globally for any +other purpose, it could be split into one to four functions (based on +how many globals it sets) and each of those functions could return the +desired value for a global. +.PP +For functions that set \f[B]seed\f[R], the value assigned to +\f[B]seed\f[R] is not propagated to parent functions. +This means that the sequence of pseudo-random numbers that they see will +not be the same sequence of pseudo-random numbers that any parent sees. +This is only the case once \f[B]seed\f[R] has been set. +.PP +If a function desires to not affect the sequence of pseudo-random +numbers of its parents, but wants to use the same \f[B]seed\f[R], it can use the following line: .IP .nf \f[C] -seed\ =\ seed -\f[] +seed = seed +\f[R] .fi .PP If the behavior of this option is desired for every run of bc(1), then -users could make sure to define \f[B]BC_ENV_ARGS\f[] and include this -option (see the \f[B]ENVIRONMENT VARIABLES\f[] section for more +users could make sure to define \f[B]BC_ENV_ARGS\f[R] and include this +option (see the \f[B]ENVIRONMENT VARIABLES\f[R] section for more details). .PP -If \f[B]\-s\f[], \f[B]\-w\f[], or any equivalents are used, this option +If \f[B]-s\f[R], \f[B]-w\f[R], or any equivalents are used, this option is ignored. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-l\f[], \f[B]\-\-mathlib\f[] -Sets \f[B]scale\f[] (see the \f[B]SYNTAX\f[] section) to \f[B]20\f[] and -loads the included math library and the extended math library before +\f[B]-l\f[R], \f[B]\[en]mathlib\f[R] +Sets \f[B]scale\f[R] (see the \f[B]SYNTAX\f[R] section) to \f[B]20\f[R] +and loads the included math library and the extended math library before running any code, including any expressions or files specified on the command line. .RS .PP -To learn what is in the libraries, see the \f[B]LIBRARY\f[] section. +To learn what is in the libraries, see the \f[B]LIBRARY\f[R] section. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-q\f[], \f[B]\-\-quiet\f[] +\f[B]-q\f[R], \f[B]\[en]quiet\f[R] This option is for compatibility with the GNU -bc(1) (https://www.gnu.org/software/bc/); it is a no\-op. +bc(1) (https://www.gnu.org/software/bc/); it is a no-op. Without this option, GNU bc(1) prints a copyright header. This bc(1) only prints the copyright header if one or more of the -\f[B]\-v\f[], \f[B]\-V\f[], or \f[B]\-\-version\f[] options are given. +\f[B]-v\f[R], \f[B]-V\f[R], or \f[B]\[en]version\f[R] options are given. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-s\f[], \f[B]\-\-standard\f[] +\f[B]-s\f[R], \f[B]\[en]standard\f[R] Process exactly the language defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) and error if any extensions are used. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-w\f[], \f[B]\-\-warn\f[] -Like \f[B]\-s\f[] and \f[B]\-\-standard\f[], except that warnings (and -not errors) are printed for non\-standard extensions and execution +\f[B]-w\f[R], \f[B]\[en]warn\f[R] +Like \f[B]-s\f[R] and \f[B]\[en]standard\f[R], except that warnings (and +not errors) are printed for non-standard extensions and execution continues normally. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -227,61 +226,61 @@ read in and evaluated first. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, bc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]bc ->&\-\f[], it will quit with an error. -This is done so that bc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]bc >&-\f[R], it will quit with an error. +This is done so that bc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other bc(1) implementations, this bc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]bc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other bc(1) implementations, this bc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]bc 2>&-\f[R], it will quit with an error. This is done so that bc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other bc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP -The syntax for bc(1) programs is mostly C\-like, with some differences. +The syntax for bc(1) programs is mostly C-like, with some differences. This bc(1) follows the POSIX standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), which is a much more thorough resource for the language this bc(1) @@ -289,388 +288,392 @@ accepts. This section is meant to be a summary and a listing of all the extensions to the standard. .PP -In the sections below, \f[B]E\f[] means expression, \f[B]S\f[] means -statement, and \f[B]I\f[] means identifier. +In the sections below, \f[B]E\f[R] means expression, \f[B]S\f[R] means +statement, and \f[B]I\f[R] means identifier. .PP -Identifiers (\f[B]I\f[]) start with a lowercase letter and can be -followed by any number (up to \f[B]BC_NAME_MAX\-1\f[]) of lowercase -letters (\f[B]a\-z\f[]), digits (\f[B]0\-9\f[]), and underscores -(\f[B]_\f[]). -The regex is \f[B][a\-z][a\-z0\-9_]*\f[]. +Identifiers (\f[B]I\f[R]) start with a lowercase letter and can be +followed by any number (up to \f[B]BC_NAME_MAX-1\f[R]) of lowercase +letters (\f[B]a-z\f[R]), digits (\f[B]0-9\f[R]), and underscores +(\f[B]_\f[R]). +The regex is \f[B][a-z][a-z0-9_]*\f[R]. Identifiers with more than one character (letter) are a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .PP -\f[B]ibase\f[] is a global variable determining how to interpret +\f[B]ibase\f[R] is a global variable determining how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +If the \f[B]-s\f[R] (\f[B]\[en]standard\f[R]) and \f[B]-w\f[R] +(\f[B]\[en]warn\f[R]) flags were not given on the command line, the max +allowable value for \f[B]ibase\f[R] is \f[B]36\f[R]. +Otherwise, it is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in bc(1) +programs with the \f[B]maxibase()\f[R] built-in function. +.PP +\f[B]obase\f[R] is a global variable determining how to output results. +It is the \[lq]output\[rq] base, or the number base used for outputting numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -If the \f[B]\-s\f[] (\f[B]\-\-standard\f[]) and \f[B]\-w\f[] -(\f[B]\-\-warn\f[]) flags were not given on the command line, the max -allowable value for \f[B]ibase\f[] is \f[B]36\f[]. -Otherwise, it is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in bc(1) -programs with the \f[B]maxibase()\f[] built\-in function. -.PP -\f[B]obase\f[] is a global variable determining how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]BC_BASE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxobase()\f[] built\-in +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]BC_BASE_MAX\f[R] and +can be queried in bc(1) programs with the \f[B]maxobase()\f[R] built-in function. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] is a global variable that sets the precision of any operations, with exceptions. -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] is \f[B]BC_SCALE_MAX\f[] and -can be queried in bc(1) programs with the \f[B]maxscale()\f[] built\-in -function. -.PP -bc(1) has both \f[I]global\f[] variables and \f[I]local\f[] variables. -All \f[I]local\f[] variables are local to the function; they are -parameters or are introduced in the \f[B]auto\f[] list of a function -(see the \f[B]FUNCTIONS\f[] section). +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] is \f[B]BC_SCALE_MAX\f[R] +and can be queried in bc(1) programs with the \f[B]maxscale()\f[R] +built-in function. +.PP +bc(1) has both \f[I]global\f[R] variables and \f[I]local\f[R] variables. +All \f[I]local\f[R] variables are local to the function; they are +parameters or are introduced in the \f[B]auto\f[R] list of a function +(see the \f[B]FUNCTIONS\f[R] section). If a variable is accessed which is not a parameter or in the -\f[B]auto\f[] list, it is assumed to be \f[I]global\f[]. -If a parent function has a \f[I]local\f[] variable version of a variable -that a child function considers \f[I]global\f[], the value of that -\f[I]global\f[] variable in the child function is the value of the +\f[B]auto\f[R] list, it is assumed to be \f[I]global\f[R]. +If a parent function has a \f[I]local\f[R] variable version of a +variable that a child function considers \f[I]global\f[R], the value of +that \f[I]global\f[R] variable in the child function is the value of the variable in the parent function, not the value of the actual -\f[I]global\f[] variable. +\f[I]global\f[R] variable. .PP All of the above applies to arrays as well. .PP The value of a statement that is an expression (i.e., any of the named expressions or operands) is printed unless the lowest precedence -operator is an assignment operator \f[I]and\f[] the expression is +operator is an assignment operator \f[I]and\f[R] the expression is notsurrounded by parentheses. .PP The value that is printed is also assigned to the special variable -\f[B]last\f[]. -A single dot (\f[B].\f[]) may also be used as a synonym for -\f[B]last\f[]. -These are \f[B]non\-portable extensions\f[]. +\f[B]last\f[R]. +A single dot (\f[B].\f[R]) may also be used as a synonym for +\f[B]last\f[R]. +These are \f[B]non-portable extensions\f[R]. .PP Either semicolons or newlines may separate statements. .SS Comments .PP There are two kinds of comments: .IP "1." 3 -Block comments are enclosed in \f[B]/*\f[] and \f[B]*/\f[]. +Block comments are enclosed in \f[B]/*\f[R] and \f[B]*/\f[R]. .IP "2." 3 -Line comments go from \f[B]#\f[] until, and not including, the next +Line comments go from \f[B]#\f[R] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Named Expressions .PP The following are named expressions in bc(1): .IP "1." 3 -Variables: \f[B]I\f[] +Variables: \f[B]I\f[R] .IP "2." 3 -Array Elements: \f[B]I[E]\f[] +Array Elements: \f[B]I[E]\f[R] .IP "3." 3 -\f[B]ibase\f[] +\f[B]ibase\f[R] .IP "4." 3 -\f[B]obase\f[] +\f[B]obase\f[R] .IP "5." 3 -\f[B]scale\f[] +\f[B]scale\f[R] .IP "6." 3 -\f[B]seed\f[] +\f[B]seed\f[R] .IP "7." 3 -\f[B]last\f[] or a single dot (\f[B].\f[]) +\f[B]last\f[R] or a single dot (\f[B].\f[R]) .PP -Numbers 6 and 7 are \f[B]non\-portable extensions\f[]. +Numbers 6 and 7 are \f[B]non-portable extensions\f[R]. .PP -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .PP -The \f[I]scale\f[] and sign of the value may be significant. -.PP -If a previously used \f[B]seed\f[] value is assigned to \f[B]seed\f[] -and used again, the pseudo\-random number generator is guaranteed to -produce the same sequence of pseudo\-random numbers as it did when the -\f[B]seed\f[] value was previously used. -.PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if \f[B]seed\f[] is queried again immediately. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will -\f[I]not\f[] produce unique sequences of pseudo\-random numbers. -The value of \f[B]seed\f[] will change after any use of the -\f[B]rand()\f[] and \f[B]irand(E)\f[] operands (see the -\f[I]Operands\f[] subsection below), except if the parameter passed to -\f[B]irand(E)\f[] is \f[B]0\f[], \f[B]1\f[], or negative. +The \f[I]scale\f[R] and sign of the value may be significant. +.PP +If a previously used \f[B]seed\f[R] value is assigned to \f[B]seed\f[R] +and used again, the pseudo-random number generator is guaranteed to +produce the same sequence of pseudo-random numbers as it did when the +\f[B]seed\f[R] value was previously used. +.PP +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if \f[B]seed\f[R] is queried again immediately. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will +\f[I]not\f[R] produce unique sequences of pseudo-random numbers. +The value of \f[B]seed\f[R] will change after any use of the +\f[B]rand()\f[R] and \f[B]irand(E)\f[R] operands (see the +\f[I]Operands\f[R] subsection below), except if the parameter passed to +\f[B]irand(E)\f[R] is \f[B]0\f[R], \f[B]1\f[R], or negative. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP Variables and arrays do not interfere; users can have arrays named the same as variables. -This also applies to functions (see the \f[B]FUNCTIONS\f[] section), so +This also applies to functions (see the \f[B]FUNCTIONS\f[R] section), so a user can have a variable, array, and function that all have the same name, and they will not shadow each other, whether inside of functions or not. .PP Named expressions are required as the operand of -\f[B]increment\f[]/\f[B]decrement\f[] operators and as the left side of -\f[B]assignment\f[] operators (see the \f[I]Operators\f[] subsection). +\f[B]increment\f[R]/\f[B]decrement\f[R] operators and as the left side +of \f[B]assignment\f[R] operators (see the \f[I]Operators\f[R] +subsection). .SS Operands .PP The following are valid operands in bc(1): .IP " 1." 4 -Numbers (see the \f[I]Numbers\f[] subsection below). +Numbers (see the \f[I]Numbers\f[R] subsection below). .IP " 2." 4 -Array indices (\f[B]I[E]\f[]). +Array indices (\f[B]I[E]\f[R]). .IP " 3." 4 -\f[B](E)\f[]: The value of \f[B]E\f[] (used to change precedence). +\f[B](E)\f[R]: The value of \f[B]E\f[R] (used to change precedence). .IP " 4." 4 -\f[B]sqrt(E)\f[]: The square root of \f[B]E\f[]. -\f[B]E\f[] must be non\-negative. +\f[B]sqrt(E)\f[R]: The square root of \f[B]E\f[R]. +\f[B]E\f[R] must be non-negative. .IP " 5." 4 -\f[B]length(E)\f[]: The number of significant decimal digits in -\f[B]E\f[]. +\f[B]length(E)\f[R]: The number of significant decimal digits in +\f[B]E\f[R]. .IP " 6." 4 -\f[B]length(I[])\f[]: The number of elements in the array \f[B]I\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]length(I[])\f[R]: The number of elements in the array \f[B]I\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 7." 4 -\f[B]scale(E)\f[]: The \f[I]scale\f[] of \f[B]E\f[]. +\f[B]scale(E)\f[R]: The \f[I]scale\f[R] of \f[B]E\f[R]. .IP " 8." 4 -\f[B]abs(E)\f[]: The absolute value of \f[B]E\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]abs(E)\f[R]: The absolute value of \f[B]E\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP " 9." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a non\-\f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a non-\f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. .IP "10." 4 -\f[B]read()\f[]: Reads a line from \f[B]stdin\f[] and uses that as an +\f[B]read()\f[R]: Reads a line from \f[B]stdin\f[R] and uses that as an expression. -The result of that expression is the result of the \f[B]read()\f[] +The result of that expression is the result of the \f[B]read()\f[R] operand. -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .IP "11." 4 -\f[B]maxibase()\f[]: The max allowable \f[B]ibase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxibase()\f[R]: The max allowable \f[B]ibase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "12." 4 -\f[B]maxobase()\f[]: The max allowable \f[B]obase\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxobase()\f[R]: The max allowable \f[B]obase\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "13." 4 -\f[B]maxscale()\f[]: The max allowable \f[B]scale\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxscale()\f[R]: The max allowable \f[B]scale\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "14." 4 -\f[B]rand()\f[]: A pseudo\-random integer between \f[B]0\f[] (inclusive) -and \f[B]BC_RAND_MAX\f[] (inclusive). -Using this operand will change the value of \f[B]seed\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]rand()\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and \f[B]BC_RAND_MAX\f[R] (inclusive). +Using this operand will change the value of \f[B]seed\f[R]. +This is a \f[B]non-portable extension\f[R]. .IP "15." 4 -\f[B]irand(E)\f[]: A pseudo\-random integer between \f[B]0\f[] -(inclusive) and the value of \f[B]E\f[] (exclusive). -If \f[B]E\f[] is negative or is a non\-integer (\f[B]E\f[]\[aq]s -\f[I]scale\f[] is not \f[B]0\f[]), an error is raised, and bc(1) resets -(see the \f[B]RESET\f[] section) while \f[B]seed\f[] remains unchanged. -If \f[B]E\f[] is larger than \f[B]BC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]BC_RAND_MAX+1\f[], and adding them +\f[B]irand(E)\f[R]: A pseudo-random integer between \f[B]0\f[R] +(inclusive) and the value of \f[B]E\f[R] (exclusive). +If \f[B]E\f[R] is negative or is a non-integer (\f[B]E\f[R]\[cq]s +\f[I]scale\f[R] is not \f[B]0\f[R]), an error is raised, and bc(1) +resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains +unchanged. +If \f[B]E\f[R] is larger than \f[B]BC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]BC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this operand is unbounded. -Using this operand will change the value of \f[B]seed\f[], unless the -value of \f[B]E\f[] is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is returned, and \f[B]seed\f[] is \f[I]not\f[] -changed. -This is a \f[B]non\-portable extension\f[]. +Using this operand will change the value of \f[B]seed\f[R], unless the +value of \f[B]E\f[R] is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is returned, and \f[B]seed\f[R] is +\f[I]not\f[R] changed. +This is a \f[B]non-portable extension\f[R]. .IP "16." 4 -\f[B]maxrand()\f[]: The max integer returned by \f[B]rand()\f[]. -This is a \f[B]non\-portable extension\f[]. +\f[B]maxrand()\f[R]: The max integer returned by \f[B]rand()\f[R]. +This is a \f[B]non-portable extension\f[R]. .PP -The integers generated by \f[B]rand()\f[] and \f[B]irand(E)\f[] are +The integers generated by \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to be as unbiased as possible, subject to the limitations of -the pseudo\-random number generator. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with \f[B]rand()\f[] and \f[B]irand(E)\f[] are guaranteed to -\f[I]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[I]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. +the pseudo-random number generator. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with \f[B]rand()\f[R] and \f[B]irand(E)\f[R] are guaranteed to +\f[I]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[I]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. .SS Numbers .PP Numbers are strings made up of digits, uppercase letters, and at most -\f[B]1\f[] period for a radix. -Numbers can have up to \f[B]BC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]BC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]Z\f[] alone always equals decimal \f[B]35\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]Z\f[R] alone always equals decimal \f[B]35\f[R]. .PP In addition, bc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e\-3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -Using scientific notation is an error or warning if the \f[B]\-s\f[] or -\f[B]\-w\f[], respectively, command\-line options (or equivalents) are +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e-3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +Using scientific notation is an error or warning if the \f[B]-s\f[R] or +\f[B]-w\f[R], respectively, command-line options (or equivalents) are given. .PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and bc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if bc(1) is given the number string -\f[B]10e\-4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if bc(1) is given the number string +\f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SS Operators .PP The following arithmetic and logical operators can be used. They are listed in order of decreasing precedence. Operators in the same group have the same precedence. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] Type: Prefix and Postfix .RS .PP Associativity: None .PP -Description: \f[B]increment\f[], \f[B]decrement\f[] +Description: \f[B]increment\f[R], \f[B]decrement\f[R] .RE .TP -.B \f[B]\-\f[] \f[B]!\f[] +\f[B]-\f[R] \f[B]!\f[R] Type: Prefix .RS .PP Associativity: None .PP -Description: \f[B]negation\f[], \f[B]boolean not\f[] +Description: \f[B]negation\f[R], \f[B]boolean not\f[R] .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] Type: Postfix .RS .PP Associativity: None .PP -Description: \f[B]truncation\f[] +Description: \f[B]truncation\f[R] .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]set precision\f[] +Description: \f[B]set precision\f[R] .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]power\f[] +Description: \f[B]power\f[R] .RE .TP -.B \f[B]*\f[] \f[B]/\f[] \f[B]%\f[] +\f[B]*\f[R] \f[B]/\f[R] \f[B]%\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]multiply\f[], \f[B]divide\f[], \f[B]modulus\f[] +Description: \f[B]multiply\f[R], \f[B]divide\f[R], \f[B]modulus\f[R] .RE .TP -.B \f[B]+\f[] \f[B]\-\f[] +\f[B]+\f[R] \f[B]-\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]add\f[], \f[B]subtract\f[] +Description: \f[B]add\f[R], \f[B]subtract\f[R] .RE .TP -.B \f[B]<<\f[] \f[B]>>\f[] +\f[B]<<\f[R] \f[B]>>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]shift left\f[], \f[B]shift right\f[] +Description: \f[B]shift left\f[R], \f[B]shift right\f[R] .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] Type: Binary .RS .PP Associativity: Right .PP -Description: \f[B]assignment\f[] +Description: \f[B]assignment\f[R] .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]relational\f[] +Description: \f[B]relational\f[R] .RE .TP -.B \f[B]&&\f[] +\f[B]&&\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean and\f[] +Description: \f[B]boolean and\f[R] .RE .TP -.B \f[B]||\f[] +\f[B]||\f[R] Type: Binary .RS .PP Associativity: Left .PP -Description: \f[B]boolean or\f[] +Description: \f[B]boolean or\f[R] .RE .PP The operators will be described in more detail below. .TP -.B \f[B]++\f[] \f[B]\-\-\f[] -The prefix and postfix \f[B]increment\f[] and \f[B]decrement\f[] +\f[B]++\f[R] \f[B]\[en]\f[R] +The prefix and postfix \f[B]increment\f[R] and \f[B]decrement\f[R] operators behave exactly like they would in C. -They require a named expression (see the \f[I]Named Expressions\f[] +They require a named expression (see the \f[I]Named Expressions\f[R] subsection) as an operand. .RS .PP @@ -678,270 +681,264 @@ The prefix versions of these operators are more efficient; use them where possible. .RE .TP -.B \f[B]\-\f[] -The \f[B]negation\f[] operator returns \f[B]0\f[] if a user attempts to -negate any expression with the value \f[B]0\f[]. +\f[B]-\f[R] +The \f[B]negation\f[R] operator returns \f[B]0\f[R] if a user attempts +to negate any expression with the value \f[B]0\f[R]. Otherwise, a copy of the expression with its sign flipped is returned. -.RS -.RE .TP -.B \f[B]!\f[] -The \f[B]boolean not\f[] operator returns \f[B]1\f[] if the expression -is \f[B]0\f[], or \f[B]0\f[] otherwise. +\f[B]!\f[R] +The \f[B]boolean not\f[R] operator returns \f[B]1\f[R] if the expression +is \f[B]0\f[R], or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] -The \f[B]truncation\f[] operator returns a copy of the given expression -with all of its \f[I]scale\f[] removed. +\f[B]$\f[R] +The \f[B]truncation\f[R] operator returns a copy of the given expression +with all of its \f[I]scale\f[R] removed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] -The \f[B]set precision\f[] operator takes two expressions and returns a -copy of the first with its \f[I]scale\f[] equal to the value of the +\f[B]\[at]\f[R] +The \f[B]set precision\f[R] operator takes two expressions and returns a +copy of the first with its \f[I]scale\f[R] equal to the value of the second expression. That could either mean that the number is returned without change (if -the \f[I]scale\f[] of the first expression matches the value of the +the \f[I]scale\f[R] of the first expression matches the value of the second expression), extended (if it is less), or truncated (if it is more). .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] -The \f[B]power\f[] operator (not the \f[B]exclusive or\f[] operator, as -it would be in C) takes two expressions and raises the first to the +\f[B]\[ha]\f[R] +The \f[B]power\f[R] operator (not the \f[B]exclusive or\f[R] operator, +as it would be in C) takes two expressions and raises the first to the power of the value of the second. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]), and if it -is negative, the first value must be non\-zero. +The second expression must be an integer (no \f[I]scale\f[R]), and if it +is negative, the first value must be non-zero. .RE .TP -.B \f[B]*\f[] -The \f[B]multiply\f[] operator takes two expressions, multiplies them, +\f[B]*\f[R] +The \f[B]multiply\f[R] operator takes two expressions, multiplies them, and returns the product. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE -.TP -.B \f[B]/\f[] -The \f[B]divide\f[] operator takes two expressions, divides them, and +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. +.TP +\f[B]/\f[R] +The \f[B]divide\f[R] operator takes two expressions, divides them, and returns the quotient. -The \f[I]scale\f[] of the result shall be the value of \f[B]scale\f[]. +The \f[I]scale\f[R] of the result shall be the value of \f[B]scale\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]%\f[] -The \f[B]modulus\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and evaluates them by 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[] and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +\f[B]%\f[R] +The \f[B]modulus\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and evaluates them by 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R] and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .RS .PP -The second expression must be non\-zero. +The second expression must be non-zero. .RE .TP -.B \f[B]+\f[] -The \f[B]add\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the sum, with a \f[I]scale\f[] equal to the max -of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]+\f[R] +The \f[B]add\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the sum, with a \f[I]scale\f[R] equal to the +max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]\-\f[] -The \f[B]subtract\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns the difference, with a \f[I]scale\f[] equal to -the max of the \f[I]scale\f[]s of \f[B]a\f[] and \f[B]b\f[]. -.RS -.RE +\f[B]-\f[R] +The \f[B]subtract\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns the difference, with a \f[I]scale\f[R] equal to +the max of the \f[I]scale\f[R]s of \f[B]a\f[R] and \f[B]b\f[R]. .TP -.B \f[B]<<\f[] -The \f[B]left shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the right. +\f[B]<<\f[R] +The \f[B]left shift\f[R] operator takes two expressions, \f[B]a\f[R] and +\f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the right. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]>>\f[] -The \f[B]right shift\f[] operator takes two expressions, \f[B]a\f[] and -\f[B]b\f[], and returns a copy of the value of \f[B]a\f[] with its -decimal point moved \f[B]b\f[] places to the left. +\f[B]>>\f[R] +The \f[B]right shift\f[R] operator takes two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and returns a copy of the value of \f[B]a\f[R] with its +decimal point moved \f[B]b\f[R] places to the left. .RS .PP -The second expression must be an integer (no \f[I]scale\f[]) and -non\-negative. +The second expression must be an integer (no \f[I]scale\f[R]) and +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[] \f[B]<<=\f[] \f[B]>>=\f[] \f[B]+=\f[] \f[B]\-=\f[] \f[B]*=\f[] \f[B]/=\f[] \f[B]%=\f[] \f[B]^=\f[] \f[B]\@=\f[] -The \f[B]assignment\f[] operators take two expressions, \f[B]a\f[] and -\f[B]b\f[] where \f[B]a\f[] is a named expression (see the \f[I]Named -Expressions\f[] subsection). +\f[B]=\f[R] \f[B]<<=\f[R] \f[B]>>=\f[R] \f[B]+=\f[R] \f[B]-=\f[R] \f[B]*=\f[R] \f[B]/=\f[R] \f[B]%=\f[R] \f[B]\[ha]=\f[R] \f[B]\[at]=\f[R] +The \f[B]assignment\f[R] operators take two expressions, \f[B]a\f[R] and +\f[B]b\f[R] where \f[B]a\f[R] is a named expression (see the \f[I]Named +Expressions\f[R] subsection). .RS .PP -For \f[B]=\f[], \f[B]b\f[] is copied and the result is assigned to -\f[B]a\f[]. -For all others, \f[B]a\f[] and \f[B]b\f[] are applied as operands to the -corresponding arithmetic operator and the result is assigned to -\f[B]a\f[]. +For \f[B]=\f[R], \f[B]b\f[R] is copied and the result is assigned to +\f[B]a\f[R]. +For all others, \f[B]a\f[R] and \f[B]b\f[R] are applied as operands to +the corresponding arithmetic operator and the result is assigned to +\f[B]a\f[R]. .PP -The \f[B]assignment\f[] operators that correspond to operators that are -extensions are themselves \f[B]non\-portable extensions\f[]. +The \f[B]assignment\f[R] operators that correspond to operators that are +extensions are themselves \f[B]non-portable extensions\f[R]. .RE .TP -.B \f[B]==\f[] \f[B]<=\f[] \f[B]>=\f[] \f[B]!=\f[] \f[B]<\f[] \f[B]>\f[] -The \f[B]relational\f[] operators compare two expressions, \f[B]a\f[] -and \f[B]b\f[], and if the relation holds, according to C language -semantics, the result is \f[B]1\f[]. -Otherwise, it is \f[B]0\f[]. +\f[B]==\f[R] \f[B]<=\f[R] \f[B]>=\f[R] \f[B]!=\f[R] \f[B]<\f[R] \f[B]>\f[R] +The \f[B]relational\f[R] operators compare two expressions, \f[B]a\f[R] +and \f[B]b\f[R], and if the relation holds, according to C language +semantics, the result is \f[B]1\f[R]. +Otherwise, it is \f[B]0\f[R]. .RS .PP Note that unlike in C, these operators have a lower precedence than the -\f[B]assignment\f[] operators, which means that \f[B]a=b>c\f[] is -interpreted as \f[B](a=b)>c\f[]. +\f[B]assignment\f[R] operators, which means that \f[B]a=b>c\f[R] is +interpreted as \f[B](a=b)>c\f[R]. .PP Also, unlike the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) requires, these operators can appear anywhere any other expressions can be used. -This allowance is a \f[B]non\-portable extension\f[]. +This allowance is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]&&\f[] -The \f[B]boolean and\f[] operator takes two expressions and returns -\f[B]1\f[] if both expressions are non\-zero, \f[B]0\f[] otherwise. +\f[B]&&\f[R] +The \f[B]boolean and\f[R] operator takes two expressions and returns +\f[B]1\f[R] if both expressions are non-zero, \f[B]0\f[R] otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]||\f[] -The \f[B]boolean or\f[] operator takes two expressions and returns -\f[B]1\f[] if one of the expressions is non\-zero, \f[B]0\f[] otherwise. +\f[B]||\f[R] +The \f[B]boolean or\f[R] operator takes two expressions and returns +\f[B]1\f[R] if one of the expressions is non-zero, \f[B]0\f[R] +otherwise. .RS .PP -This is \f[I]not\f[] a short\-circuit operator. +This is \f[I]not\f[R] a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Statements .PP The following items are statements: .IP " 1." 4 -\f[B]E\f[] +\f[B]E\f[R] .IP " 2." 4 -\f[B]{\f[] \f[B]S\f[] \f[B];\f[] ... -\f[B];\f[] \f[B]S\f[] \f[B]}\f[] +\f[B]{\f[R] \f[B]S\f[R] \f[B];\f[R] \&... \f[B];\f[R] \f[B]S\f[R] +\f[B]}\f[R] .IP " 3." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 4." 4 -\f[B]if\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] \f[B]else\f[] -\f[B]S\f[] +\f[B]if\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] +\f[B]else\f[R] \f[B]S\f[R] .IP " 5." 4 -\f[B]while\f[] \f[B](\f[] \f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]while\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 6." 4 -\f[B]for\f[] \f[B](\f[] \f[B]E\f[] \f[B];\f[] \f[B]E\f[] \f[B];\f[] -\f[B]E\f[] \f[B])\f[] \f[B]S\f[] +\f[B]for\f[R] \f[B](\f[R] \f[B]E\f[R] \f[B];\f[R] \f[B]E\f[R] +\f[B];\f[R] \f[B]E\f[R] \f[B])\f[R] \f[B]S\f[R] .IP " 7." 4 An empty statement .IP " 8." 4 -\f[B]break\f[] +\f[B]break\f[R] .IP " 9." 4 -\f[B]continue\f[] +\f[B]continue\f[R] .IP "10." 4 -\f[B]quit\f[] +\f[B]quit\f[R] .IP "11." 4 -\f[B]halt\f[] +\f[B]halt\f[R] .IP "12." 4 -\f[B]limits\f[] +\f[B]limits\f[R] .IP "13." 4 A string of characters, enclosed in double quotes .IP "14." 4 -\f[B]print\f[] \f[B]E\f[] \f[B],\f[] ... -\f[B],\f[] \f[B]E\f[] +\f[B]print\f[R] \f[B]E\f[R] \f[B],\f[R] \&... \f[B],\f[R] \f[B]E\f[R] .IP "15." 4 -\f[B]I()\f[], \f[B]I(E)\f[], \f[B]I(E, E)\f[], and so on, where -\f[B]I\f[] is an identifier for a \f[B]void\f[] function (see the -\f[I]Void Functions\f[] subsection of the \f[B]FUNCTIONS\f[] section). -The \f[B]E\f[] argument(s) may also be arrays of the form \f[B]I[]\f[], -which will automatically be turned into array references (see the -\f[I]Array References\f[] subsection of the \f[B]FUNCTIONS\f[] section) -if the corresponding parameter in the function definition is an array -reference. -.PP -Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non\-portable extensions\f[]. -.PP -Also, as a \f[B]non\-portable extension\f[], any or all of the +\f[B]I()\f[R], \f[B]I(E)\f[R], \f[B]I(E, E)\f[R], and so on, where +\f[B]I\f[R] is an identifier for a \f[B]void\f[R] function (see the +\f[I]Void Functions\f[R] subsection of the \f[B]FUNCTIONS\f[R] section). +The \f[B]E\f[R] argument(s) may also be arrays of the form +\f[B]I[]\f[R], which will automatically be turned into array references +(see the \f[I]Array References\f[R] subsection of the +\f[B]FUNCTIONS\f[R] section) if the corresponding parameter in the +function definition is an array reference. +.PP +Numbers 4, 9, 11, 12, 14, and 15 are \f[B]non-portable extensions\f[R]. +.PP +Also, as a \f[B]non-portable extension\f[R], any or all of the expressions in the header of a for loop may be omitted. If the condition (second expression) is omitted, it is assumed to be a -constant \f[B]1\f[]. +constant \f[B]1\f[R]. .PP -The \f[B]break\f[] statement causes a loop to stop iterating and resume +The \f[B]break\f[R] statement causes a loop to stop iterating and resume execution immediately following a loop. This is only allowed in loops. .PP -The \f[B]continue\f[] statement causes a loop iteration to stop early +The \f[B]continue\f[R] statement causes a loop iteration to stop early and returns to the start of the loop, including testing the loop condition. This is only allowed in loops. .PP -The \f[B]if\f[] \f[B]else\f[] statement does the same thing as in C. +The \f[B]if\f[R] \f[B]else\f[R] statement does the same thing as in C. .PP -The \f[B]quit\f[] statement causes bc(1) to quit, even if it is on a -branch that will not be executed (it is a compile\-time command). +The \f[B]quit\f[R] statement causes bc(1) to quit, even if it is on a +branch that will not be executed (it is a compile-time command). .PP -The \f[B]halt\f[] statement causes bc(1) to quit, if it is executed. -(Unlike \f[B]quit\f[] if it is on a branch of an \f[B]if\f[] statement +The \f[B]halt\f[R] statement causes bc(1) to quit, if it is executed. +(Unlike \f[B]quit\f[R] if it is on a branch of an \f[B]if\f[R] statement that is not executed, bc(1) does not quit.) .PP -The \f[B]limits\f[] statement prints the limits that this bc(1) is +The \f[B]limits\f[R] statement prints the limits that this bc(1) is subject to. -This is like the \f[B]quit\f[] statement in that it is a compile\-time +This is like the \f[B]quit\f[R] statement in that it is a compile-time command. .PP An expression by itself is evaluated and printed, followed by a newline. .PP Both scientific notation and engineering notation are available for printing the results of expressions. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[], and engineering notation is activated by assigning -\f[B]1\f[] to \f[B]obase\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R], and engineering notation is activated by assigning +\f[B]1\f[R] to \f[B]obase\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Scientific notation and engineering notation are disabled if bc(1) is -run with either the \f[B]\-s\f[] or \f[B]\-w\f[] command\-line options +run with either the \f[B]-s\f[R] or \f[B]-w\f[R] command-line options (or equivalents). .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .SS Print Statement .PP -The "expressions" in a \f[B]print\f[] statement may also be strings. +The \[lq]expressions\[rq] in a \f[B]print\f[R] statement may also be +strings. If they are, there are backslash escape sequences that are interpreted specially. What those sequences are, and what they cause to be printed, are shown @@ -951,152 +948,152 @@ below: tab(@); l l. T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T}@T{ -\f[B]\\a\f[] +\f[B]\[rs]a\f[R] T} T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T}@T{ -\f[B]\\b\f[] +\f[B]\[rs]b\f[R] T} T{ -\f[B]\\\\\f[] +\f[B]\[rs]\[rs]\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\e\f[] +\f[B]\[rs]e\f[R] T}@T{ -\f[B]\\\f[] +\f[B]\[rs]\f[R] T} T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T}@T{ -\f[B]\\f\f[] +\f[B]\[rs]f\f[R] T} T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T}@T{ -\f[B]\\n\f[] +\f[B]\[rs]n\f[R] T} T{ -\f[B]\\q\f[] +\f[B]\[rs]q\f[R] T}@T{ -\f[B]"\f[] +\f[B]\[dq]\f[R] T} T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T}@T{ -\f[B]\\r\f[] +\f[B]\[rs]r\f[R] T} T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T}@T{ -\f[B]\\t\f[] +\f[B]\[rs]t\f[R] T} .TE .PP Any other character following a backslash causes the backslash and -character to be printed as\-is. +character to be printed as-is. .PP -Any non\-string expression in a print statement shall be assigned to -\f[B]last\f[], like any other expression that is printed. +Any non-string expression in a print statement shall be assigned to +\f[B]last\f[R], like any other expression that is printed. .SS Order of Evaluation .PP All expressions in a statment are evaluated left to right, except as necessary to maintain order of operations. -This means, for example, assuming that \f[B]i\f[] is equal to -\f[B]0\f[], in the expression +This means, for example, assuming that \f[B]i\f[R] is equal to +\f[B]0\f[R], in the expression .IP .nf \f[C] -a[i++]\ =\ i++ -\f[] +a[i++] = i++ +\f[R] .fi .PP -the first (or 0th) element of \f[B]a\f[] is set to \f[B]1\f[], and -\f[B]i\f[] is equal to \f[B]2\f[] at the end of the expression. +the first (or 0th) element of \f[B]a\f[R] is set to \f[B]1\f[R], and +\f[B]i\f[R] is equal to \f[B]2\f[R] at the end of the expression. .PP This includes function arguments. -Thus, assuming \f[B]i\f[] is equal to \f[B]0\f[], this means that in the -expression +Thus, assuming \f[B]i\f[R] is equal to \f[B]0\f[R], this means that in +the expression .IP .nf \f[C] -x(i++,\ i++) -\f[] +x(i++, i++) +\f[R] .fi .PP -the first argument passed to \f[B]x()\f[] is \f[B]0\f[], and the second -argument is \f[B]1\f[], while \f[B]i\f[] is equal to \f[B]2\f[] before -the function starts executing. +the first argument passed to \f[B]x()\f[R] is \f[B]0\f[R], and the +second argument is \f[B]1\f[R], while \f[B]i\f[R] is equal to +\f[B]2\f[R] before the function starts executing. .SH FUNCTIONS .PP Function definitions are as follows: .IP .nf \f[C] -define\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return(E) +define I(I,...,I){ + auto I,...,I + S;...;S + return(E) } -\f[] +\f[R] .fi .PP -Any \f[B]I\f[] in the parameter list or \f[B]auto\f[] list may be -replaced with \f[B]I[]\f[] to make a parameter or \f[B]auto\f[] var an -array, and any \f[B]I\f[] in the parameter list may be replaced with -\f[B]*I[]\f[] to make a parameter an array reference. +Any \f[B]I\f[R] in the parameter list or \f[B]auto\f[R] list may be +replaced with \f[B]I[]\f[R] to make a parameter or \f[B]auto\f[R] var an +array, and any \f[B]I\f[R] in the parameter list may be replaced with +\f[B]*I[]\f[R] to make a parameter an array reference. Callers of functions that take array references should not put an -asterisk in the call; they must be called with just \f[B]I[]\f[] like +asterisk in the call; they must be called with just \f[B]I[]\f[R] like normal array parameters and will be automatically converted into references. .PP -As a \f[B]non\-portable extension\f[], the opening brace of a -\f[B]define\f[] statement may appear on the next line. +As a \f[B]non-portable extension\f[R], the opening brace of a +\f[B]define\f[R] statement may appear on the next line. .PP -As a \f[B]non\-portable extension\f[], the return statement may also be +As a \f[B]non-portable extension\f[R], the return statement may also be in one of the following forms: .IP "1." 3 -\f[B]return\f[] +\f[B]return\f[R] .IP "2." 3 -\f[B]return\f[] \f[B](\f[] \f[B])\f[] +\f[B]return\f[R] \f[B](\f[R] \f[B])\f[R] .IP "3." 3 -\f[B]return\f[] \f[B]E\f[] +\f[B]return\f[R] \f[B]E\f[R] .PP -The first two, or not specifying a \f[B]return\f[] statement, is -equivalent to \f[B]return (0)\f[], unless the function is a -\f[B]void\f[] function (see the \f[I]Void Functions\f[] subsection +The first two, or not specifying a \f[B]return\f[R] statement, is +equivalent to \f[B]return (0)\f[R], unless the function is a +\f[B]void\f[R] function (see the \f[I]Void Functions\f[R] subsection below). .SS Void Functions .PP -Functions can also be \f[B]void\f[] functions, defined as follows: +Functions can also be \f[B]void\f[R] functions, defined as follows: .IP .nf \f[C] -define\ void\ I(I,...,I){ -\ \ \ \ auto\ I,...,I -\ \ \ \ S;...;S -\ \ \ \ return +define void I(I,...,I){ + auto I,...,I + S;...;S + return } -\f[] +\f[R] .fi .PP They can only be used as standalone expressions, where such an expression would be printed alone, except in a print statement. .PP -Void functions can only use the first two \f[B]return\f[] statements +Void functions can only use the first two \f[B]return\f[R] statements listed above. They can also omit the return statement entirely. .PP -The word "void" is not treated as a keyword; it is still possible to -have variables, arrays, and functions named \f[B]void\f[]. -The word "void" is only treated specially right after the -\f[B]define\f[] keyword. +The word \[lq]void\[rq] is not treated as a keyword; it is still +possible to have variables, arrays, and functions named \f[B]void\f[R]. +The word \[lq]void\[rq] is only treated specially right after the +\f[B]define\f[R] keyword. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SS Array References .PP For any array in the parameter list, if the array is declared in the @@ -1105,23 +1102,23 @@ form .nf \f[C] *I[] -\f[] +\f[R] .fi .PP -it is a \f[B]reference\f[]. +it is a \f[B]reference\f[R]. Any changes to the array in the function are reflected, when the function returns, to the array that was passed in. .PP Other than this, all function arguments are passed by value. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .SH LIBRARY .PP All of the functions below, including the functions in the extended math -library (see the \f[I]Extended Library\f[] subsection below), are -available when the \f[B]\-l\f[] or \f[B]\-\-mathlib\f[] command\-line +library (see the \f[I]Extended Library\f[R] subsection below), are +available when the \f[B]-l\f[R] or \f[B]\[en]mathlib\f[R] command-line flags are given, except that the extended math library is not available -when the \f[B]\-s\f[] option, the \f[B]\-w\f[] option, or equivalents +when the \f[B]-s\f[R] option, the \f[B]-w\f[R] option, or equivalents are given. .SS Standard Library .PP @@ -1129,545 +1126,528 @@ The standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) defines the following functions for the math library: .TP -.B \f[B]s(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]s(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]c(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]c(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]a(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]a(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l(x)\f[] -Returns the natural logarithm of \f[B]x\f[]. +\f[B]l(x)\f[R] +Returns the natural logarithm of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]e(x)\f[] -Returns the mathematical constant \f[B]e\f[] raised to the power of -\f[B]x\f[]. +\f[B]e(x)\f[R] +Returns the mathematical constant \f[B]e\f[R] raised to the power of +\f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]j(x, n)\f[] -Returns the bessel integer order \f[B]n\f[] (truncated) of \f[B]x\f[]. +\f[B]j(x, n)\f[R] +Returns the bessel integer order \f[B]n\f[R] (truncated) of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .SS Extended Library .PP -The extended library is \f[I]not\f[] loaded when the -\f[B]\-s\f[]/\f[B]\-\-standard\f[] or \f[B]\-w\f[]/\f[B]\-\-warn\f[] +The extended library is \f[I]not\f[R] loaded when the +\f[B]-s\f[R]/\f[B]\[en]standard\f[R] or \f[B]-w\f[R]/\f[B]\[en]warn\f[R] options are given since they are not part of the library defined by the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html). .PP -The extended library is a \f[B]non\-portable extension\f[]. +The extended library is a \f[B]non-portable extension\f[R]. .TP -.B \f[B]p(x, y)\f[] -Calculates \f[B]x\f[] to the power of \f[B]y\f[], even if \f[B]y\f[] is -not an integer, and returns the result to the current \f[B]scale\f[]. +\f[B]p(x, y)\f[R] +Calculates \f[B]x\f[R] to the power of \f[B]y\f[R], even if \f[B]y\f[R] +is not an integer, and returns the result to the current +\f[B]scale\f[R]. .RS .PP +It is an error if \f[B]y\f[R] is negative and \f[B]x\f[R] is +\f[B]0\f[R]. +.PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round half away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). -.RS -.RE +\f[B]r(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round half away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Round_half_away_from_zero). .TP -.B \f[B]ceil(x, p)\f[] -Returns \f[B]x\f[] rounded to \f[B]p\f[] decimal places according to the -rounding mode round away from -\f[B]0\f[] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). -.RS -.RE +\f[B]ceil(x, p)\f[R] +Returns \f[B]x\f[R] rounded to \f[B]p\f[R] decimal places according to +the rounding mode round away from +\f[B]0\f[R] (https://en.wikipedia.org/wiki/Rounding#Rounding_away_from_zero). .TP -.B \f[B]f(x)\f[] -Returns the factorial of the truncated absolute value of \f[B]x\f[]. -.RS -.RE +\f[B]f(x)\f[R] +Returns the factorial of the truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]perm(n, k)\f[] -Returns the permutation of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]perm(n, k)\f[R] +Returns the permutation of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]comb(n, k)\f[] -Returns the combination of the truncated absolute value of \f[B]n\f[] of -the truncated absolute value of \f[B]k\f[], if \f[B]k <= n\f[]. -If not, it returns \f[B]0\f[]. -.RS -.RE +\f[B]comb(n, k)\f[R] +Returns the combination of the truncated absolute value of \f[B]n\f[R] +of the truncated absolute value of \f[B]k\f[R], if \f[B]k <= n\f[R]. +If not, it returns \f[B]0\f[R]. .TP -.B \f[B]l2(x)\f[] -Returns the logarithm base \f[B]2\f[] of \f[B]x\f[]. +\f[B]l2(x)\f[R] +Returns the logarithm base \f[B]2\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]l10(x)\f[] -Returns the logarithm base \f[B]10\f[] of \f[B]x\f[]. +\f[B]l10(x)\f[R] +Returns the logarithm base \f[B]10\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]log(x, b)\f[] -Returns the logarithm base \f[B]b\f[] of \f[B]x\f[]. +\f[B]log(x, b)\f[R] +Returns the logarithm base \f[B]b\f[R] of \f[B]x\f[R]. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cbrt(x)\f[] -Returns the cube root of \f[B]x\f[]. -.RS -.RE +\f[B]cbrt(x)\f[R] +Returns the cube root of \f[B]x\f[R]. .TP -.B \f[B]root(x, n)\f[] -Calculates the truncated value of \f[B]n\f[], \f[B]r\f[], and returns -the \f[B]r\f[]th root of \f[B]x\f[] to the current \f[B]scale\f[]. +\f[B]root(x, n)\f[R] +Calculates the truncated value of \f[B]n\f[R], \f[B]r\f[R], and returns +the \f[B]r\f[R]th root of \f[B]x\f[R] to the current \f[B]scale\f[R]. .RS .PP -If \f[B]r\f[] is \f[B]0\f[] or negative, this raises an error and causes -bc(1) to reset (see the \f[B]RESET\f[] section). -It also raises an error and causes bc(1) to reset if \f[B]r\f[] is even -and \f[B]x\f[] is negative. +If \f[B]r\f[R] is \f[B]0\f[R] or negative, this raises an error and +causes bc(1) to reset (see the \f[B]RESET\f[R] section). +It also raises an error and causes bc(1) to reset if \f[B]r\f[R] is even +and \f[B]x\f[R] is negative. .RE .TP -.B \f[B]pi(p)\f[] -Returns \f[B]pi\f[] to \f[B]p\f[] decimal places. +\f[B]pi(p)\f[R] +Returns \f[B]pi\f[R] to \f[B]p\f[R] decimal places. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]t(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]t(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]a2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]a2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]sin(x)\f[] -Returns the sine of \f[B]x\f[], which is assumed to be in radians. +\f[B]sin(x)\f[R] +Returns the sine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]s(x)\f[]. +This is an alias of \f[B]s(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]cos(x)\f[] -Returns the cosine of \f[B]x\f[], which is assumed to be in radians. +\f[B]cos(x)\f[R] +Returns the cosine of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -This is an alias of \f[B]c(x)\f[]. +This is an alias of \f[B]c(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]tan(x)\f[] -Returns the tangent of \f[B]x\f[], which is assumed to be in radians. +\f[B]tan(x)\f[R] +Returns the tangent of \f[B]x\f[R], which is assumed to be in radians. .RS .PP -If \f[B]x\f[] is equal to \f[B]1\f[] or \f[B]\-1\f[], this raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is equal to \f[B]1\f[R] or \f[B]-1\f[R], this raises an +error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). .PP -This is an alias of \f[B]t(x)\f[]. +This is an alias of \f[B]t(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]atan(x)\f[] -Returns the arctangent of \f[B]x\f[], in radians. +\f[B]atan(x)\f[R] +Returns the arctangent of \f[B]x\f[R], in radians. .RS .PP -This is an alias of \f[B]a(x)\f[]. +This is an alias of \f[B]a(x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). -.RE -.TP -.B \f[B]atan2(y, x)\f[] -Returns the arctangent of \f[B]y/x\f[], in radians. -If both \f[B]y\f[] and \f[B]x\f[] are equal to \f[B]0\f[], it raises an -error and causes bc(1) to reset (see the \f[B]RESET\f[] section). -Otherwise, if \f[B]x\f[] is greater than \f[B]0\f[], it returns -\f[B]a(y/x)\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is greater than or -equal to \f[B]0\f[], it returns \f[B]a(y/x)+pi\f[]. -If \f[B]x\f[] is less than \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]a(y/x)\-pi\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is greater than -\f[B]0\f[], it returns \f[B]pi/2\f[]. -If \f[B]x\f[] is equal to \f[B]0\f[], and \f[B]y\f[] is less than -\f[B]0\f[], it returns \f[B]\-pi/2\f[]. -.RS -.PP -This function is the same as the \f[B]atan2()\f[] function in many +Functions\f[R] subsection below). +.RE +.TP +\f[B]atan2(y, x)\f[R] +Returns the arctangent of \f[B]y/x\f[R], in radians. +If both \f[B]y\f[R] and \f[B]x\f[R] are equal to \f[B]0\f[R], it raises +an error and causes bc(1) to reset (see the \f[B]RESET\f[R] section). +Otherwise, if \f[B]x\f[R] is greater than \f[B]0\f[R], it returns +\f[B]a(y/x)\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is greater than +or equal to \f[B]0\f[R], it returns \f[B]a(y/x)+pi\f[R]. +If \f[B]x\f[R] is less than \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]a(y/x)-pi\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is greater than +\f[B]0\f[R], it returns \f[B]pi/2\f[R]. +If \f[B]x\f[R] is equal to \f[B]0\f[R], and \f[B]y\f[R] is less than +\f[B]0\f[R], it returns \f[B]-pi/2\f[R]. +.RS +.PP +This function is the same as the \f[B]atan2()\f[R] function in many programming languages. .PP -This is an alias of \f[B]a2(y, x)\f[]. +This is an alias of \f[B]a2(y, x)\f[R]. .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]r2d(x)\f[] -Converts \f[B]x\f[] from radians to degrees and returns the result. +\f[B]r2d(x)\f[R] +Converts \f[B]x\f[R] from radians to degrees and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]d2r(x)\f[] -Converts \f[B]x\f[] from degrees to radians and returns the result. +\f[B]d2r(x)\f[R] +Converts \f[B]x\f[R] from degrees to radians and returns the result. .RS .PP This is a transcendental function (see the \f[I]Transcendental -Functions\f[] subsection below). +Functions\f[R] subsection below). .RE .TP -.B \f[B]frand(p)\f[] -Generates a pseudo\-random number between \f[B]0\f[] (inclusive) and -\f[B]1\f[] (exclusive) with the number of decimal digits after the -decimal point equal to the truncated absolute value of \f[B]p\f[]. -If \f[B]p\f[] is not \f[B]0\f[], then calling this function will change -the value of \f[B]seed\f[]. -If \f[B]p\f[] is \f[B]0\f[], then \f[B]0\f[] is returned, and -\f[B]seed\f[] is \f[I]not\f[] changed. -.RS -.RE +\f[B]frand(p)\f[R] +Generates a pseudo-random number between \f[B]0\f[R] (inclusive) and +\f[B]1\f[R] (exclusive) with the number of decimal digits after the +decimal point equal to the truncated absolute value of \f[B]p\f[R]. +If \f[B]p\f[R] is not \f[B]0\f[R], then calling this function will +change the value of \f[B]seed\f[R]. +If \f[B]p\f[R] is \f[B]0\f[R], then \f[B]0\f[R] is returned, and +\f[B]seed\f[R] is \f[I]not\f[R] changed. .TP -.B \f[B]ifrand(i, p)\f[] -Generates a pseudo\-random number that is between \f[B]0\f[] (inclusive) -and the truncated absolute value of \f[B]i\f[] (exclusive) with the +\f[B]ifrand(i, p)\f[R] +Generates a pseudo-random number that is between \f[B]0\f[R] (inclusive) +and the truncated absolute value of \f[B]i\f[R] (exclusive) with the number of decimal digits after the decimal point equal to the truncated -absolute value of \f[B]p\f[]. -If the absolute value of \f[B]i\f[] is greater than or equal to -\f[B]2\f[], and \f[B]p\f[] is not \f[B]0\f[], then calling this function -will change the value of \f[B]seed\f[]; otherwise, \f[B]0\f[] is -returned and \f[B]seed\f[] is not changed. -.RS -.RE +absolute value of \f[B]p\f[R]. +If the absolute value of \f[B]i\f[R] is greater than or equal to +\f[B]2\f[R], and \f[B]p\f[R] is not \f[B]0\f[R], then calling this +function will change the value of \f[B]seed\f[R]; otherwise, \f[B]0\f[R] +is returned and \f[B]seed\f[R] is not changed. .TP -.B \f[B]srand(x)\f[] -Returns \f[B]x\f[] with its sign flipped with probability \f[B]0.5\f[]. -In other words, it randomizes the sign of \f[B]x\f[]. -.RS -.RE +\f[B]srand(x)\f[R] +Returns \f[B]x\f[R] with its sign flipped with probability +\f[B]0.5\f[R]. +In other words, it randomizes the sign of \f[B]x\f[R]. .TP -.B \f[B]brand()\f[] -Returns a random boolean value (either \f[B]0\f[] or \f[B]1\f[]). -.RS -.RE +\f[B]brand()\f[R] +Returns a random boolean value (either \f[B]0\f[R] or \f[B]1\f[R]). .TP -.B \f[B]ubytes(x)\f[] +\f[B]ubytes(x)\f[R] Returns the numbers of unsigned integer bytes required to hold the -truncated absolute value of \f[B]x\f[]. -.RS -.RE +truncated absolute value of \f[B]x\f[R]. .TP -.B \f[B]sbytes(x)\f[] -Returns the numbers of signed, two\[aq]s\-complement integer bytes -required to hold the truncated value of \f[B]x\f[]. -.RS -.RE +\f[B]sbytes(x)\f[R] +Returns the numbers of signed, two\[cq]s-complement integer bytes +required to hold the truncated value of \f[B]x\f[R]. .TP -.B \f[B]hex(x)\f[] -Outputs the hexadecimal (base \f[B]16\f[]) representation of \f[B]x\f[]. +\f[B]hex(x)\f[R] +Outputs the hexadecimal (base \f[B]16\f[R]) representation of +\f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary(x)\f[] -Outputs the binary (base \f[B]2\f[]) representation of \f[B]x\f[]. +\f[B]binary(x)\f[R] +Outputs the binary (base \f[B]2\f[R]) representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output(x, b)\f[] -Outputs the base \f[B]b\f[] representation of \f[B]x\f[]. +\f[B]output(x, b)\f[R] +Outputs the base \f[B]b\f[R] representation of \f[B]x\f[R]. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as +\f[B]uint(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as an unsigned integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or is negative, an error message is -printed instead, but bc(1) is not reset (see the \f[B]RESET\f[] +If \f[B]x\f[R] is not an integer or is negative, an error message is +printed instead, but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in as few power of two bytes as +\f[B]int(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in as few power of two bytes as possible. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, an error message is printed instead, -but bc(1) is not reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, an error message is printed instead, +but bc(1) is not reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uintn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]n\f[] bytes. +\f[B]uintn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]n\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]n\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]intn(x, n)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]n\f[] bytes. +\f[B]intn(x, n)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]n\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]n\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]n\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]1\f[] byte. +\f[B]uint8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]1\f[] byte, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int8(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]1\f[] byte. +\f[B]int8(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]1\f[R] byte. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]1\f[] byte, an +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]1\f[R] byte, an error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]2\f[] bytes. +\f[B]uint16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]2\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]2\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int16(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]2\f[] bytes. +\f[B]int16(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]2\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]2\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]2\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]4\f[] bytes. +\f[B]uint32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]4\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]4\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int32(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]4\f[] bytes. +\f[B]int32(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]4\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]4\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]4\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]uint64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -an unsigned integer in \f[B]8\f[] bytes. +\f[B]uint64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +an unsigned integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer, is negative, or cannot fit into -\f[B]8\f[] bytes, an error message is printed instead, but bc(1) is not -reset (see the \f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer, is negative, or cannot fit into +\f[B]8\f[R] bytes, an error message is printed instead, but bc(1) is not +reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]int64(x)\f[] -Outputs the representation, in binary and hexadecimal, of \f[B]x\f[] as -a signed, two\[aq]s\-complement integer in \f[B]8\f[] bytes. +\f[B]int64(x)\f[R] +Outputs the representation, in binary and hexadecimal, of \f[B]x\f[R] as +a signed, two\[cq]s-complement integer in \f[B]8\f[R] bytes. Both outputs are split into bytes separated by spaces. .RS .PP -If \f[B]x\f[] is not an integer or cannot fit into \f[B]8\f[] bytes, an -error message is printed instead, but bc(1) is not reset (see the -\f[B]RESET\f[] section). +If \f[B]x\f[R] is not an integer or cannot fit into \f[B]8\f[R] bytes, +an error message is printed instead, but bc(1) is not reset (see the +\f[B]RESET\f[R] section). .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]hex_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in hexadecimal using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]hex_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in hexadecimal using \f[B]n\f[R] +bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]binary_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in binary using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]binary_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in binary using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_uint(x, n)\f[] -Outputs the representation of the truncated absolute value of \f[B]x\f[] -as an unsigned integer in the current \f[B]obase\f[] (see the -\f[B]SYNTAX\f[] section) using \f[B]n\f[] bytes. -Not all of the value will be output if \f[B]n\f[] is too small. +\f[B]output_uint(x, n)\f[R] +Outputs the representation of the truncated absolute value of +\f[B]x\f[R] as an unsigned integer in the current \f[B]obase\f[R] (see +the \f[B]SYNTAX\f[R] section) using \f[B]n\f[R] bytes. +Not all of the value will be output if \f[B]n\f[R] is too small. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .TP -.B \f[B]output_byte(x, i)\f[] -Outputs byte \f[B]i\f[] of the truncated absolute value of \f[B]x\f[], -where \f[B]0\f[] is the least significant byte and \f[B]number_of_bytes -\- 1\f[] is the most significant byte. +\f[B]output_byte(x, i)\f[R] +Outputs byte \f[B]i\f[R] of the truncated absolute value of \f[B]x\f[R], +where \f[B]0\f[R] is the least significant byte and \f[B]number_of_bytes +- 1\f[R] is the most significant byte. .RS .PP -This is a \f[B]void\f[] function (see the \f[I]Void Functions\f[] -subsection of the \f[B]FUNCTIONS\f[] section). +This is a \f[B]void\f[R] function (see the \f[I]Void Functions\f[R] +subsection of the \f[B]FUNCTIONS\f[R] section). .RE .SS Transcendental Functions .PP @@ -1679,55 +1659,55 @@ why it is impossible and unnecessary to calculate exact results for the transcendental functions. .PP Because of the possible inaccuracy, I recommend that users call those -functions with the precision (\f[B]scale\f[]) set to at least 1 higher +functions with the precision (\f[B]scale\f[R]) set to at least 1 higher than is necessary. -If exact results are \f[I]absolutely\f[] required, users can double the -precision (\f[B]scale\f[]) and then truncate. +If exact results are \f[I]absolutely\f[R] required, users can double the +precision (\f[B]scale\f[R]) and then truncate. .PP The transcendental functions in the standard math library are: .IP \[bu] 2 -\f[B]s(x)\f[] +\f[B]s(x)\f[R] .IP \[bu] 2 -\f[B]c(x)\f[] +\f[B]c(x)\f[R] .IP \[bu] 2 -\f[B]a(x)\f[] +\f[B]a(x)\f[R] .IP \[bu] 2 -\f[B]l(x)\f[] +\f[B]l(x)\f[R] .IP \[bu] 2 -\f[B]e(x)\f[] +\f[B]e(x)\f[R] .IP \[bu] 2 -\f[B]j(x, n)\f[] +\f[B]j(x, n)\f[R] .PP The transcendental functions in the extended math library are: .IP \[bu] 2 -\f[B]l2(x)\f[] +\f[B]l2(x)\f[R] .IP \[bu] 2 -\f[B]l10(x)\f[] +\f[B]l10(x)\f[R] .IP \[bu] 2 -\f[B]log(x, b)\f[] +\f[B]log(x, b)\f[R] .IP \[bu] 2 -\f[B]pi(p)\f[] +\f[B]pi(p)\f[R] .IP \[bu] 2 -\f[B]t(x)\f[] +\f[B]t(x)\f[R] .IP \[bu] 2 -\f[B]a2(y, x)\f[] +\f[B]a2(y, x)\f[R] .IP \[bu] 2 -\f[B]sin(x)\f[] +\f[B]sin(x)\f[R] .IP \[bu] 2 -\f[B]cos(x)\f[] +\f[B]cos(x)\f[R] .IP \[bu] 2 -\f[B]tan(x)\f[] +\f[B]tan(x)\f[R] .IP \[bu] 2 -\f[B]atan(x)\f[] +\f[B]atan(x)\f[R] .IP \[bu] 2 -\f[B]atan2(y, x)\f[] +\f[B]atan2(y, x)\f[R] .IP \[bu] 2 -\f[B]r2d(x)\f[] +\f[B]r2d(x)\f[R] .IP \[bu] 2 -\f[B]d2r(x)\f[] +\f[B]d2r(x)\f[R] .SH RESET .PP -When bc(1) encounters an error or a signal that it has a non\-default +When bc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1740,7 +1720,7 @@ Then the execution point is set so that any code waiting to execute Thus, when bc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .PP Note that this reset behavior is different from the GNU bc(1), which @@ -1748,333 +1728,302 @@ attempts to start executing the statement right after the one that caused an error. .SH PERFORMANCE .PP -Most bc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This bc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]BC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]BC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]BC_BASE_DIGS\f[]. +\f[B]BC_BASE_DIGS\f[R]. .PP -The actual values of \f[B]BC_LONG_BIT\f[] and \f[B]BC_BASE_DIGS\f[] can -be queried with the \f[B]limits\f[] statement. +The actual values of \f[B]BC_LONG_BIT\f[R] and \f[B]BC_BASE_DIGS\f[R] +can be queried with the \f[B]limits\f[R] statement. .PP In addition, this bc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]BC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on bc(1): .TP -.B \f[B]BC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where bc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]BC_BASE_DIGS\f[] +\f[B]BC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_POW\f[] +\f[B]BC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]BC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]BC_BASE_DIGS\f[]. -.RS -.RE +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. .TP -.B \f[B]BC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]BC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]BC_LONG_BIT\f[R]. .TP -.B \f[B]BC_BASE_MAX\f[] +\f[B]BC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]BC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]BC_BASE_POW\f[R]. .TP -.B \f[B]BC_DIM_MAX\f[] +\f[B]BC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]BC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_STRING_MAX\f[] +\f[B]BC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NAME_MAX\f[] +\f[B]BC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_NUM_MAX\f[] +\f[B]BC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]BC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]BC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]rand()\f[] operand. -Set at \f[B]2^BC_LONG_BIT\-1\f[]. -.RS -.RE +\f[B]BC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]rand()\f[R] +operand. +Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]BC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]BC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -The actual values can be queried with the \f[B]limits\f[] statement. +The actual values can be queried with the \f[B]limits\f[R] statement. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP bc(1) recognizes the following environment variables: .TP -.B \f[B]POSIXLY_CORRECT\f[] +\f[B]POSIXLY_CORRECT\f[R] If this variable exists (no matter the contents), bc(1) behaves as if -the \f[B]\-s\f[] option was given. -.RS -.RE +the \f[B]-s\f[R] option was given. .TP -.B \f[B]BC_ENV_ARGS\f[] -This is another way to give command\-line arguments to bc(1). -They should be in the same format as all other command\-line arguments. +\f[B]BC_ENV_ARGS\f[R] +This is another way to give command-line arguments to bc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]BC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]BC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time bc(1) runs. .RS .PP -The code that parses \f[B]BC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]BC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some bc file.bc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "bc" -file.bc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some bc file.bc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]bc\[dq] file.bc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]BC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]BC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]BC_LINE_LENGTH\f[] +\f[B]BC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), bc(1) will output lines to that length, including -the backslash (\f[B]\\\f[]). -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), bc(1) will output lines to that length, +including the backslash (\f[B]\[rs]\f[R]). +The default line length is \f[B]70\f[R]. .SH EXIT STATUS .PP bc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]<<\f[]), and -right shift (\f[B]>>\f[]) operators and their corresponding assignment -operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]<<\f[R]), and right shift (\f[B]>>\f[R]) operators and their +corresponding assignment operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, using a token where it is invalid, giving an invalid expression, giving an invalid print statement, giving an invalid function definition, attempting to assign to an expression that is not a named expression (see the -\f[I]Named Expressions\f[] subsection of the \f[B]SYNTAX\f[] section), -giving an invalid \f[B]auto\f[] list, having a duplicate -\f[B]auto\f[]/function parameter, failing to find the end of a code -block, attempting to return a value from a \f[B]void\f[] function, +\f[I]Named Expressions\f[R] subsection of the \f[B]SYNTAX\f[R] section), +giving an invalid \f[B]auto\f[R] list, having a duplicate +\f[B]auto\f[R]/function parameter, failing to find the end of a code +block, attempting to return a value from a \f[B]void\f[R] function, attempting to use a variable as a reference, and using any extensions -when the option \f[B]\-s\f[] or any equivalents were given. +when the option \f[B]-s\f[R] or any equivalents were given. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, passing the wrong number of arguments -to functions, attempting to call an undefined function, and attempting -to use a \f[B]void\f[] function call as a value in an expression. +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, passing the wrong number of +arguments to functions, attempting to call an undefined function, and +attempting to use a \f[B]void\f[R] function call as a value in an +expression. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (bc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, bc(1) -always exits and returns \f[B]4\f[], no matter what mode bc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, bc(1) +always exits and returns \f[B]4\f[R], no matter what mode bc(1) is in. .PP The other statuses will only be returned when bc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -bc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +bc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow bc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP Per the standard (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -bc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +bc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, bc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, bc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, bc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause bc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause bc(1) to stop execution of the current input. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If bc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If bc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If bc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to bc(1) as it is executing -a file, it can seem as though bc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to bc(1) as it is +executing a file, it can seem as though bc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with bc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause bc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when bc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause bc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause bc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when bc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause bc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -bc(1) supports interactive command\-line editing. -If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +bc(1) supports interactive command-line editing. +If bc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This bc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGES\f[]. +locales and thus, supports \f[B]LC_MESSAGES\f[R]. .SH SEE ALSO .PP dc(1) .SH STANDARDS .PP -bc(1) is compliant with the IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) is compliant with the IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. -The flags \f[B]\-efghiqsvVw\f[], all long options, and the extensions +The flags \f[B]-efghiqsvVw\f[R], all long options, and the extensions noted above are extensions to that specification. .PP Note that the specification explicitly says that bc(1) only accepts -numbers that use a period (\f[B].\f[]) as a radix point, regardless of -the value of \f[B]LC_NUMERIC\f[]. +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. .PP This bc(1) supports error messages for different locales, and thus, it -supports \f[B]LC_MESSAGES\f[]. +supports \f[B]LC_MESSAGES\f[R]. .SH BUGS .PP None are known. @@ -2082,4 +2031,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHORS .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bc/P.1.md b/contrib/bc/manuals/bc/P.1.md index 1058a91aa6d2..af712806cfc7 100644 --- a/contrib/bc/manuals/bc/P.1.md +++ b/contrib/bc/manuals/bc/P.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # NAME -bc - arbitrary-precision arithmetic language and calculator +bc - arbitrary-precision decimal arithmetic language and calculator # SYNOPSIS @@ -415,9 +415,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **35**. In addition, bc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e-3** is equal to **0.0042890**. Using scientific notation is an error or warning if the **-s** or **-w**, respectively, command-line options (or equivalents) are given. @@ -580,7 +580,7 @@ The operators will be described in more detail below. : The **power** operator (not the **exclusive or** operator, as it would be in C) takes two expressions and raises the first to the power of the value of - the second. + the second. The *scale* of the result is equal to **scale**. The second expression must be an integer (no *scale*), and if it is negative, the first value must be non-zero. @@ -929,6 +929,8 @@ The extended library is a **non-portable extension**. : Calculates **x** to the power of **y**, even if **y** is not an integer, and returns the result to the current **scale**. + It is an error if **y** is negative and **x** is **0**. + This is a transcendental function (see the *Transcendental Functions* subsection below). @@ -1675,7 +1677,7 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHORS -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html [2]: https://www.gnu.org/software/bc/ diff --git a/contrib/bc/manuals/bcl.3 b/contrib/bc/manuals/bcl.3 new file mode 100644 index 000000000000..cb56f9dd8491 --- /dev/null +++ b/contrib/bc/manuals/bcl.3 @@ -0,0 +1,1365 @@ +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.\" Copyright (c) 2018-2020 Gavin D. Howard and contributors. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions are met: +.\" +.\" * Redistributions of source code must retain the above copyright notice, +.\" this list of conditions and the following disclaimer. +.\" +.\" * Redistributions in binary form must reproduce the above copyright notice, +.\" this list of conditions and the following disclaimer in the documentation +.\" and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" +.TH "BCL" "3" "October 2020" "Gavin D. Howard" "Libraries Manual" +.SH NAME +.PP +bcl - library of arbitrary precision decimal arithmetic +.SH SYNOPSIS +.SS Use +.PP +\f[I]#include <bcl.h>\f[R] +.PP +Link with \f[I]-lbcl\f[R]. +.SS Signals +.PP +This procedure will allow clients to use signals to interrupt +computations running in bcl(3). +.PP +\f[B]void bcl_handleSignal(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]bool bcl_running(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.SS Setup +.PP +These items allow clients to set up bcl(3). +.PP +\f[B]BclError bcl_init(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_free(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]bool bcl_abortOnFatalError(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_setAbortOnFatalError(bool\f[R] \f[I]abrt\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_gc(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.SS Contexts +.PP +These items will allow clients to handle contexts, which are isolated +from each other. +This allows more than one client to use bcl(3) in the same program. +.PP +\f[B]struct BclCtxt;\f[R] +.PP +\f[B]typedef struct BclCtxt* BclContext;\f[R] +.PP +\f[B]BclContext bcl_ctxt_create(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_ctxt_free(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] +.PP +\f[B]BclError bcl_pushContext(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_popContext(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]BclContext bcl_context(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_ctxt_freeNums(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] +.PP +\f[B]size_t bcl_ctxt_scale(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_ctxt_setScale(BclContext\f[R] \f[I]ctxt\f[R]\f[B], +size_t\f[R] \f[I]scale\f[R]\f[B]);\f[R] +.PP +\f[B]size_t bcl_ctxt_ibase(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_ctxt_setIbase(BclContext\f[R] \f[I]ctxt\f[R]\f[B], +size_t\f[R] \f[I]ibase\f[R]\f[B]);\f[R] +.PP +\f[B]size_t bcl_ctxt_obase(BclContext\f[R] \f[I]ctxt\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_ctxt_setObase(BclContext\f[R] \f[I]ctxt\f[R]\f[B], +size_t\f[R] \f[I]obase\f[R]\f[B]);\f[R] +.SS Errors +.PP +These items allow clients to handle errors. +.PP +\f[B]typedef enum BclError BclError;\f[R] +.PP +\f[B]BclError bcl_err(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] +.SS Numbers +.PP +These items allow clients to manipulate and query the +arbitrary-precision numbers managed by bcl(3). +.PP +\f[B]typedef struct { size_t i; } BclNumber;\f[R] +.PP +\f[B]BclNumber bcl_num_create(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_num_free(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] +.PP +\f[B]bool bcl_num_neg(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_num_setNeg(BclNumber\f[R] \f[I]n\f[R]\f[B], bool\f[R] +\f[I]neg\f[R]\f[B]);\f[R] +.PP +\f[B]size_t bcl_num_scale(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] +.PP +\f[B]BclError bcl_num_setScale(BclNumber\f[R] \f[I]n\f[R]\f[B], +size_t\f[R] \f[I]scale\f[R]\f[B]);\f[R] +.PP +\f[B]size_t bcl_num_len(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] +.SS Conversion +.PP +These items allow clients to convert numbers into and from strings and +integers. +.PP +\f[B]BclNumber bcl_parse(const char *restrict\f[R] +\f[I]val\f[R]\f[B]);\f[R] +.PP +\f[B]char* bcl_string(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] +.PP +\f[B]BclError bcl_bigdig(BclNumber\f[R] \f[I]n\f[R]\f[B], BclBigDig +*\f[R]\f[I]result\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_bigdig2num(BclBigDig\f[R] \f[I]val\f[R]\f[B]);\f[R] +.SS Math +.PP +These items allow clients to run math on numbers. +.PP +\f[B]BclNumber bcl_add(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] +\f[I]b\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_sub(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] +\f[I]b\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_mul(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] +\f[I]b\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_div(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] +\f[I]b\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_mod(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] +\f[I]b\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_pow(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] +\f[I]b\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_lshift(BclNumber\f[R] \f[I]a\f[R]\f[B], +BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_rshift(BclNumber\f[R] \f[I]a\f[R]\f[B], +BclNumber\f[R] \f[I]b\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_sqrt(BclNumber\f[R] \f[I]a\f[R]\f[B]);\f[R] +.PP +\f[B]BclError bcl_divmod(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] +\f[I]b\f[R]\f[B], BclNumber *\f[R]\f[I]c\f[R]\f[B], BclNumber +*\f[R]\f[I]d\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_modexp(BclNumber\f[R] \f[I]a\f[R]\f[B], +BclNumber\f[R] \f[I]b\f[R]\f[B], BclNumber\f[R] \f[I]c\f[R]\f[B]);\f[R] +.SS Miscellaneous +.PP +These items are miscellaneous. +.PP +\f[B]void bcl_zero(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] +.PP +\f[B]void bcl_one(BclNumber\f[R] \f[I]n\f[R]\f[B]);\f[R] +.PP +\f[B]ssize_t bcl_cmp(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] +\f[I]b\f[R]\f[B]);\f[R] +.PP +\f[B]BclError bcl_copy(BclNumber\f[R] \f[I]d\f[R]\f[B], BclNumber\f[R] +\f[I]s\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_dup(BclNumber\f[R] \f[I]s\f[R]\f[B]);\f[R] +.SS Pseudo-Random Number Generator +.PP +These items allow clients to manipulate the seeded pseudo-random number +generator in bcl(3). +.PP +\f[B]#define BCL_SEED_ULONGS\f[R] +.PP +\f[B]#define BCL_SEED_SIZE\f[R] +.PP +\f[B]typedef unsigned long BclBigDig;\f[R] +.PP +\f[B]typedef unsigned long BclRandInt;\f[R] +.PP +\f[B]BclNumber bcl_irand(BclNumber\f[R] \f[I]a\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_frand(size_t\f[R] \f[I]places\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_ifrand(BclNumber\f[R] \f[I]a\f[R]\f[B], size_t\f[R] +\f[I]places\f[R]\f[B]);\f[R] +.PP +\f[B]BclError bcl_rand_seedWithNum(BclNumber\f[R] +\f[I]n\f[R]\f[B]);\f[R] +.PP +\f[B]BclError bcl_rand_seed(unsigned char\f[R] +\f[I]seed\f[R]\f[B][\f[R]\f[I]BC_SEED_SIZE\f[R]\f[B]]);\f[R] +.PP +\f[B]void bcl_rand_reseed(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]BclNumber bcl_rand_seed2num(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]BclRandInt bcl_rand_int(\f[R]\f[I]void\f[R]\f[B]);\f[R] +.PP +\f[B]BclRandInt bcl_rand_bounded(BclRandInt\f[R] +\f[I]bound\f[R]\f[B]);\f[R] +.SH DESCRIPTION +.PP +bcl(3) is a library that implements arbitrary-precision decimal math, as +standardized by +POSIX (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +in bc(1). +.PP +bcl(3) is async-signal-safe if +\f[B]bcl_handleSignal(\f[R]\f[I]void\f[R]\f[B])\f[R] is used properly. +(See the \f[B]SIGNAL HANDLING\f[R] section.) +.PP +All of the items in its interface are described below. +See the documentation for each function for what each function can +return. +.SS Signals +.TP +\f[B]void bcl_handleSignal(\f[R]\f[I]void\f[R]\f[B])\f[R] +An async-signal-safe function that can be called from a signal handler. +If called from a signal handler on the same thread as any executing +bcl(3) functions, it will interrupt the functions and force them to +return early. +It is undefined behavior if this function is called from a thread that +is \f[I]not\f[R] executing any bcl(3) functions while any bcl(3) +functions are executing. +.RS +.PP +If execution \f[I]is\f[R] interrupted, +\f[B]bcl_handleSignal(\f[R]\f[I]void\f[R]\f[B])\f[R] does \f[I]not\f[R] +return to its caller. +.PP +See the \f[B]SIGNAL HANDLING\f[R] section. +.RE +.TP +\f[B]bool bcl_running(\f[R]\f[I]void\f[R]\f[B])\f[R] +An async-signal-safe function that can be called from a signal handler. +It will return \f[B]true\f[R] if any bcl(3) procedures are running, +which means it is safe to call +\f[B]bcl_handleSignal(\f[R]\f[I]void\f[R]\f[B])\f[R]. +Otherwise, it returns \f[B]false\f[R]. +.RS +.PP +See the \f[B]SIGNAL HANDLING\f[R] section. +.RE +.SS Setup +.TP +\f[B]BclError bcl_init(\f[R]\f[I]void\f[R]\f[B])\f[R] +Initializes this library. +This function can be called multiple times, but each call must be +matched by a call to \f[B]bcl_free(\f[R]\f[I]void\f[R]\f[B])\f[R]. +This is to make it possible for multiple libraries and applications to +initialize bcl(3) without problem. +.RS +.PP +If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. +Otherwise, this function can return: +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.PP +This function must be the first one clients call. +Calling any other function without calling this one first is undefined +behavior. +.RE +.TP +\f[B]void bcl_free(\f[R]\f[I]void\f[R]\f[B])\f[R] +Decrements bcl(3)\[cq]s reference count and frees the data associated +with it if the reference count is \f[B]0\f[R]. +.RS +.PP +This function must be the last one clients call. +Calling this function before calling any other function is undefined +behavior. +.RE +.TP +\f[B]bool bcl_abortOnFatalError(\f[R]\f[I]void\f[R]\f[B])\f[R] +Queries and returns the current state of calling \f[B]abort()\f[R] on +fatal errors. +If \f[B]true\f[R] is returned, bcl(3) will cause a \f[B]SIGABRT\f[R] if +a fatal error occurs. +.RS +.PP +If activated, clients do not need to check for fatal errors. +.RE +.TP +\f[B]void bcl_setAbortOnFatalError(bool\f[R] \f[I]abrt\f[R]\f[B])\f[R] +Sets the state of calling \f[B]abort()\f[R] on fatal errors. +If \f[I]abrt\f[R] is \f[B]false\f[R], bcl(3) will not cause a +\f[B]SIGABRT\f[R] on fatal errors after the call. +If \f[I]abrt\f[R] is \f[B]true\f[R], bcl(3) will cause a +\f[B]SIGABRT\f[R] on fatal errors after the call. +.RS +.PP +If activated, clients do not need to check for fatal errors. +.RE +.TP +\f[B]void bcl_gc(\f[R]\f[I]void\f[R]\f[B])\f[R] +Garbage collects cached instances of arbitrary-precision numbers. +This only frees the memory of numbers that are \f[I]not\f[R] in use, so +it is safe to call at any time. +.SS Contexts +.PP +All procedures that take a \f[B]BclContext\f[R] parameter a require a +valid context as an argument. +.TP +\f[B]struct BclCtxt\f[R] +A forward declaration for a hidden \f[B]struct\f[R] type. +Clients cannot access the internals of the \f[B]struct\f[R] type +directly. +All interactions with the type are done through pointers. +See \f[B]BclContext\f[R] below. +.TP +\f[B]BclContext\f[R] +A typedef to a pointer of \f[B]struct BclCtxt\f[R]. +This is the only handle clients can get to \f[B]struct BclCtxt\f[R]. +.RS +.PP +A \f[B]BclContext\f[R] contains the values \f[B]scale\f[R], +\f[B]ibase\f[R], and \f[B]obase\f[R], as well as a list of numbers. +.PP +\f[B]scale\f[R] is a value used to control how many decimal places +calculations should use. +A value of \f[B]0\f[R] means that calculations are done on integers +only, where applicable, and a value of 20, for example, means that all +applicable calculations return results with 20 decimal places. +The default is \f[B]0\f[R]. +.PP +\f[B]ibase\f[R] is a value used to control the input base. +The minimum \f[B]ibase\f[R] is \f[B]2\f[R], and the maximum is +\f[B]36\f[R]. +If \f[B]ibase\f[R] is \f[B]2\f[R], numbers are parsed as though they are +in binary, and any digits larger than \f[B]1\f[R] are clamped. +Likewise, a value of \f[B]10\f[R] means that numbers are parsed as +though they are decimal, and any larger digits are clamped. +The default is \f[B]10\f[R]. +.PP +\f[B]obase\f[R] is a value used to control the output base. +The minimum \f[B]obase\f[R] is \f[B]0\f[R] and the maximum is +\f[B]BC_BASE_MAX\f[R] (see the \f[B]LIMITS\f[R] section). +.PP +Numbers created in one context are not valid in another context. +It is undefined behavior to use a number created in a different context. +Contexts are meant to isolate the numbers used by different clients in +the same application. +.RE +.TP +\f[B]BclContext bcl_ctxt_create(\f[R]\f[I]void\f[R]\f[B])\f[R] +Creates a context and returns it. +Returns \f[B]NULL\f[R] if there was an error. +.TP +\f[B]void bcl_ctxt_free(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] +Frees \f[I]ctxt\f[R], after which it is no longer valid. +It is undefined behavior to attempt to use an invalid context. +.TP +\f[B]BclError bcl_pushContext(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] +Pushes \f[I]ctxt\f[R] onto bcl(3)\[cq]s stack of contexts. +\f[I]ctxt\f[R] must have been created with +\f[B]bcl_ctxt_create(\f[R]\f[I]void\f[R]\f[B])\f[R]. +.RS +.PP +If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. +Otherwise, this function can return: +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.PP +There \f[I]must\f[R] be a valid context to do any arithmetic. +.RE +.TP +\f[B]void bcl_popContext(\f[R]\f[I]void\f[R]\f[B])\f[R] +Pops the current context off of the stack, if one exists. +.TP +\f[B]BclContext bcl_context(\f[R]\f[I]void\f[R]\f[B])\f[R] +Returns the current context, or \f[B]NULL\f[R] if no context exists. +.TP +\f[B]void bcl_ctxt_freeNums(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] +Frees all numbers in use that are associated with \f[I]ctxt\f[R]. +It is undefined behavior to attempt to use a number associated with +\f[I]ctxt\f[R] after calling this procedure unless such numbers have +been created with \f[B]bcl_num_create(\f[R]\f[I]void\f[R]\f[B])\f[R] +after calling this procedure. +.TP +\f[B]size_t bcl_ctxt_scale(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] +Returns the \f[B]scale\f[R] for given context. +.TP +\f[B]void bcl_ctxt_setScale(BclContext\f[R] \f[I]ctxt\f[R]\f[B], size_t\f[R] \f[I]scale\f[R]\f[B])\f[R] +Sets the \f[B]scale\f[R] for the given context to the argument +\f[I]scale\f[R]. +.TP +\f[B]size_t bcl_ctxt_ibase(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] +Returns the \f[B]ibase\f[R] for the given context. +.TP +\f[B]void bcl_ctxt_setIbase(BclContext\f[R] \f[I]ctxt\f[R]\f[B], size_t\f[R] \f[I]ibase\f[R]\f[B])\f[R] +Sets the \f[B]ibase\f[R] for the given context to the argument +\f[I]ibase\f[R]. +If the argument \f[I]ibase\f[R] is invalid, it clamped, so an +\f[I]ibase\f[R] of \f[B]0\f[R] or \f[B]1\f[R] is clamped to \f[B]2\f[R], +and any values above \f[B]36\f[R] are clamped to \f[B]36\f[R]. +.TP +\f[B]size_t bcl_ctxt_obase(BclContext\f[R] \f[I]ctxt\f[R]\f[B])\f[R] +Returns the \f[B]obase\f[R] for the given context. +.TP +\f[B]void bcl_ctxt_setObase(BclContext\f[R] \f[I]ctxt\f[R]\f[B], size_t\f[R] \f[I]obase\f[R]\f[B])\f[R] +Sets the \f[B]obase\f[R] for the given context to the argument +\f[I]obase\f[R]. +.SS Errors +.TP +\f[B]BclError\f[R] +An \f[B]enum\f[R] of possible error codes. +See the \f[B]ERRORS\f[R] section for a complete listing the codes. +.TP +\f[B]BclError bcl_err(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] +Checks for errors in a \f[B]BclNumber\f[R]. +All functions that can return a \f[B]BclNumber\f[R] can encode an error +in the number, and this function will return the error, if any. +If there was no error, it will return \f[B]BCL_ERROR_NONE\f[R]. +.RS +.PP +There must be a valid current context. +.RE +.SS Numbers +.PP +All procedures in this section require a valid current context. +.TP +\f[B]BclNumber\f[R] +A handle to an arbitrary-precision number. +The actual number type is not exposed; the \f[B]BclNumber\f[R] handle is +the only way clients can refer to instances of arbitrary-precision +numbers. +.TP +\f[B]BclNumber bcl_num_create(\f[R]\f[I]void\f[R]\f[B])\f[R] +Creates and returns a \f[B]BclNumber\f[R]. +.RS +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]void bcl_num_free(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] +Frees \f[I]n\f[R]. +It is undefined behavior to use \f[I]n\f[R] after calling this function. +.TP +\f[B]bool bcl_num_neg(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] +Returns \f[B]true\f[R] if \f[I]n\f[R] is negative, \f[B]false\f[R] +otherwise. +.TP +\f[B]void bcl_num_setNeg(BclNumber\f[R] \f[I]n\f[R]\f[B], bool\f[R] \f[I]neg\f[R]\f[B])\f[R] +Sets \f[I]n\f[R]\[cq]s sign to \f[I]neg\f[R], where \f[B]true\f[R] is +negative, and \f[B]false\f[R] is positive. +.TP +\f[B]size_t bcl_num_scale(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] +Returns the \f[I]scale\f[R] of \f[I]n\f[R]. +.RS +.PP +The \f[I]scale\f[R] of a number is the number of decimal places it has +after the radix (decimal point). +.RE +.TP +\f[B]BclError bcl_num_setScale(BclNumber\f[R] \f[I]n\f[R]\f[B], size_t\f[R] \f[I]scale\f[R]\f[B])\f[R] +Sets the \f[I]scale\f[R] of \f[I]n\f[R] to the argument \f[I]scale\f[R]. +If the argument \f[I]scale\f[R] is greater than the \f[I]scale\f[R] of +\f[I]n\f[R], \f[I]n\f[R] is extended. +If the argument \f[I]scale\f[R] is less than the \f[I]scale\f[R] of +\f[I]n\f[R], \f[I]n\f[R] is truncated. +.RS +.PP +If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. +Otherwise, this function can return: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]size_t bcl_num_len(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] +Returns the number of \f[I]significant decimal digits\f[R] in +\f[I]n\f[R]. +.SS Conversion +.PP +All procedures in this section require a valid current context. +.PP +All procedures in this section consume the given \f[B]BclNumber\f[R] +arguments that are not given to pointer arguments. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.TP +\f[B]BclNumber bcl_parse(const char *restrict\f[R] \f[I]val\f[R]\f[B])\f[R] +Parses a number string according to the current context\[cq]s +\f[B]ibase\f[R] and returns the resulting number. +.RS +.PP +\f[I]val\f[R] must be non-\f[B]NULL\f[R] and a valid string. +See \f[B]BCL_ERROR_PARSE_INVALID_STR\f[R] in the \f[B]ERRORS\f[R] +section for more information. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_PARSE_INVALID_STR\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]char* bcl_string(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] +Returns a string representation of \f[I]n\f[R] according the the current +context\[cq]s \f[B]ibase\f[R]. +The string is dynamically allocated and must be freed by the caller. +.RS +.PP +\f[I]n\f[R] is consumed; it cannot be used after the call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.RE +.TP +\f[B]BclError bcl_bigdig(BclNumber\f[R] \f[I]n\f[R]\f[B], BclBigDig *\f[R]\f[I]result\f[R]\f[B])\f[R] +Converts \f[I]n\f[R] into a \f[B]BclBigDig\f[R] and returns the result +in the space pointed to by \f[I]result\f[R]. +.RS +.PP +\f[I]a\f[R] must be smaller than \f[B]BC_OVERFLOW_MAX\f[R]. +See the \f[B]LIMITS\f[R] section. +.PP +If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. +Otherwise, this function can return: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_OVERFLOW\f[R] +.PP +\f[I]n\f[R] is consumed; it cannot be used after the call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.RE +.TP +\f[B]BclNumber bcl_bigdig2num(BclBigDig\f[R] \f[I]val\f[R]\f[B])\f[R] +Creates a \f[B]BclNumber\f[R] from \f[I]val\f[R]. +.RS +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.SS Math +.PP +All procedures in this section require a valid current context. +.PP +All procedures in this section can return the following errors: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.TP +\f[B]BclNumber bcl_add(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] +Adds \f[I]a\f[R] and \f[I]b\f[R] and returns the result. +The \f[I]scale\f[R] of the result is the max of the \f[I]scale\f[R]s of +\f[I]a\f[R] and \f[I]b\f[R]. +.RS +.PP +\f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the +call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +\f[I]a\f[R] and \f[I]b\f[R] can be the same number. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_sub(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] +Subtracts \f[I]b\f[R] from \f[I]a\f[R] and returns the result. +The \f[I]scale\f[R] of the result is the max of the \f[I]scale\f[R]s of +\f[I]a\f[R] and \f[I]b\f[R]. +.RS +.PP +\f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the +call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +\f[I]a\f[R] and \f[I]b\f[R] can be the same number. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_mul(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] +Multiplies \f[I]a\f[R] and \f[I]b\f[R] and returns the result. +If \f[I]ascale\f[R] is the \f[I]scale\f[R] of \f[I]a\f[R] and +\f[I]bscale\f[R] is the \f[I]scale\f[R] of \f[I]b\f[R], the +\f[I]scale\f[R] of the result is equal to +\f[B]min(ascale+bscale,max(scale,ascale,bscale))\f[R], where +\f[B]min()\f[R] and \f[B]max()\f[R] return the obvious values. +.RS +.PP +\f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the +call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +\f[I]a\f[R] and \f[I]b\f[R] can be the same number. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_div(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] +Divides \f[I]a\f[R] by \f[I]b\f[R] and returns the result. +The \f[I]scale\f[R] of the result is the \f[I]scale\f[R] of the current +context. +.RS +.PP +\f[I]b\f[R] cannot be \f[B]0\f[R]. +.PP +\f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the +call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +\f[I]a\f[R] and \f[I]b\f[R] can be the same number. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_mod(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] +Divides \f[I]a\f[R] by \f[I]b\f[R] to the \f[I]scale\f[R] of the current +context, computes the modulus \f[B]a-(a/b)*b\f[R], and returns the +modulus. +.RS +.PP +\f[I]b\f[R] cannot be \f[B]0\f[R]. +.PP +\f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the +call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +\f[I]a\f[R] and \f[I]b\f[R] can be the same number. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_pow(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] +Calculates \f[I]a\f[R] to the power of \f[I]b\f[R] to the +\f[I]scale\f[R] of the current context. +\f[I]b\f[R] must be an integer, but can be negative. +If it is negative, \f[I]a\f[R] must be non-zero. +.RS +.PP +\f[I]b\f[R] must be an integer. +If \f[I]b\f[R] is negative, \f[I]a\f[R] must not be \f[B]0\f[R]. +.PP +\f[I]a\f[R] must be smaller than \f[B]BC_OVERFLOW_MAX\f[R]. +See the \f[B]LIMITS\f[R] section. +.PP +\f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the +call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +\f[I]a\f[R] and \f[I]b\f[R] can be the same number. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_OVERFLOW\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_lshift(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] +Shifts \f[I]a\f[R] left (moves the radix right) by \f[I]b\f[R] places +and returns the result. +This is done in decimal. +\f[I]b\f[R] must be an integer. +.RS +.PP +\f[I]b\f[R] must be an integer. +.PP +\f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the +call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +\f[I]a\f[R] and \f[I]b\f[R] can be the same number. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_rshift(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] +Shifts \f[I]a\f[R] right (moves the radix left) by \f[I]b\f[R] places +and returns the result. +This is done in decimal. +\f[I]b\f[R] must be an integer. +.RS +.PP +\f[I]b\f[R] must be an integer. +.PP +\f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the +call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +\f[I]a\f[R] and \f[I]b\f[R] can be the same number. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_sqrt(BclNumber\f[R] \f[I]a\f[R]\f[B])\f[R] +Calculates the square root of \f[I]a\f[R] and returns the result. +The \f[I]scale\f[R] of the result is equal to the \f[B]scale\f[R] of the +current context. +.RS +.PP +\f[I]a\f[R] cannot be negative. +.PP +\f[I]a\f[R] is consumed; it cannot be used after the call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_NEGATIVE\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclError bcl_divmod(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B], BclNumber *\f[R]\f[I]c\f[R]\f[B], BclNumber *\f[R]\f[I]d\f[R]\f[B])\f[R] +Divides \f[I]a\f[R] by \f[I]b\f[R] and returns the quotient in a new +number which is put into the space pointed to by \f[I]c\f[R], and puts +the modulus in a new number which is put into the space pointed to by +\f[I]d\f[R]. +.RS +.PP +\f[I]b\f[R] cannot be \f[B]0\f[R]. +.PP +\f[I]a\f[R] and \f[I]b\f[R] are consumed; they cannot be used after the +call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +\f[I]c\f[R] and \f[I]d\f[R] cannot point to the same place, nor can they +point to the space occupied by \f[I]a\f[R] or \f[I]b\f[R]. +.PP +If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. +Otherwise, this function can return: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_modexp(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B], BclNumber\f[R] \f[I]c\f[R]\f[B])\f[R] +Computes a modular exponentiation where \f[I]a\f[R] is the base, +\f[I]b\f[R] is the exponent, and \f[I]c\f[R] is the modulus, and returns +the result. +The \f[I]scale\f[R] of the result is equal to the \f[B]scale\f[R] of the +current context. +.RS +.PP +\f[I]a\f[R], \f[I]b\f[R], and \f[I]c\f[R] must be integers. +\f[I]c\f[R] must not be \f[B]0\f[R]. +\f[I]b\f[R] must not be negative. +.PP +\f[I]a\f[R], \f[I]b\f[R], and \f[I]c\f[R] are consumed; they cannot be +used after the call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_NEGATIVE\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.SS Miscellaneous +.TP +\f[B]void bcl_zero(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] +Sets \f[I]n\f[R] to \f[B]0\f[R]. +.TP +\f[B]void bcl_one(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] +Sets \f[I]n\f[R] to \f[B]1\f[R]. +.TP +\f[B]ssize_t bcl_cmp(BclNumber\f[R] \f[I]a\f[R]\f[B], BclNumber\f[R] \f[I]b\f[R]\f[B])\f[R] +Compares \f[I]a\f[R] and \f[I]b\f[R] and returns \f[B]0\f[R] if +\f[I]a\f[R] and \f[I]b\f[R] are equal, \f[B]<0\f[R] if \f[I]a\f[R] is +less than \f[I]b\f[R], and \f[B]>0\f[R] if \f[I]a\f[R] is greater than +\f[I]b\f[R]. +.TP +\f[B]BclError bcl_copy(BclNumber\f[R] \f[I]d\f[R]\f[B], BclNumber\f[R] \f[I]s\f[R]\f[B])\f[R] +Copies \f[I]s\f[R] into \f[I]d\f[R]. +.RS +.PP +If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. +Otherwise, this function can return: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_dup(BclNumber\f[R] \f[I]s\f[R]\f[B])\f[R] +Creates and returns a new \f[B]BclNumber\f[R] that is a copy of +\f[I]s\f[R]. +.RS +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.SS Pseudo-Random Number Generator +.PP +The pseudo-random number generator in bcl(3) is a \f[I]seeded\f[R] PRNG. +Given the same seed twice, it will produce the same sequence of +pseudo-random numbers twice. +.PP +By default, bcl(3) attempts to seed the PRNG with data from +\f[B]/dev/urandom\f[R]. +If that fails, it seeds itself with by calling \f[B]libc\f[R]\[cq]s +\f[B]srand(time(NULL))\f[R] and then calling \f[B]rand()\f[R] for each +byte, since \f[B]rand()\f[R] is only guaranteed to return \f[B]15\f[R] +bits. +.PP +This should provide fairly good seeding in the standard case while also +remaining fairly portable. +.PP +If necessary, the PRNG can be reseeded with one of the following +functions: +.IP \[bu] 2 +\f[B]bcl_rand_seedWithNum(BclNumber)\f[R] +.IP \[bu] 2 +\f[B]bcl_rand_seed(unsigned char[BC_SEED_SIZE])\f[R] +.IP \[bu] 2 +\f[B]bcl_rand_reseed(\f[R]\f[I]void\f[R]\f[B])\f[R] +.PP +The following items allow clients to use the pseudo-random number +generator. +All procedures require a valid current context. +.TP +\f[B]BCL_SEED_ULONGS\f[R] +The number of \f[B]unsigned long\f[R]\[cq]s in a seed for bcl(3)\[cq]s +random number generator. +.TP +\f[B]BCL_SEED_SIZE\f[R] +The size, in \f[B]char\f[R]\[cq]s, of a seed for bcl(3)\[cq]s random +number generator. +.TP +\f[B]BclBigDig\f[R] +bcl(3)\[cq]s overflow type (see the \f[B]PERFORMANCE\f[R] section). +.TP +\f[B]BclRandInt\f[R] +An unsigned integer type returned by bcl(3)\[cq]s random number +generator. +.TP +\f[B]BclNumber bcl_irand(BclNumber\f[R] \f[I]a\f[R]\f[B])\f[R] +Returns a random number that is not larger than \f[I]a\f[R] in a new +number. +If \f[I]a\f[R] is \f[B]0\f[R] or \f[B]1\f[R], the new number is equal to +\f[B]0\f[R]. +The bound is unlimited, so it is not bound to the size of +\f[B]BclRandInt\f[R]. +This is done by generating as many random numbers as necessary, +multiplying them by certain exponents, and adding them all together. +.RS +.PP +\f[I]a\f[R] must be an integer and non-negative. +.PP +\f[I]a\f[R] is consumed; it cannot be used after the call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +This procedure requires a valid current context. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_NEGATIVE\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_frand(size_t\f[R] \f[I]places\f[R]\f[B])\f[R] +Returns a random number between \f[B]0\f[R] (inclusive) and \f[B]1\f[R] +(exclusive) that has \f[I]places\f[R] decimal digits after the radix +(decimal point). +There are no limits on \f[I]places\f[R]. +.RS +.PP +This procedure requires a valid current context. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclNumber bcl_ifrand(BclNumber\f[R] \f[I]a\f[R]\f[B], size_t\f[R] \f[I]places\f[R]\f[B])\f[R] +Returns a random number less than \f[I]a\f[R] with \f[I]places\f[R] +decimal digits after the radix (decimal point). +There are no limits on \f[I]a\f[R] or \f[I]places\f[R]. +.RS +.PP +\f[I]a\f[R] must be an integer and non-negative. +.PP +\f[I]a\f[R] is consumed; it cannot be used after the call. +See the \f[B]Consumption and Propagation\f[R] subsection below. +.PP +This procedure requires a valid current context. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_NEGATIVE\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclError bcl_rand_seedWithNum(BclNumber\f[R] \f[I]n\f[R]\f[B])\f[R] +Seeds the PRNG with \f[I]n\f[R]. +.RS +.PP +\f[I]n\f[R] is \f[I]not\f[R] consumed. +.PP +This procedure requires a valid current context. +.PP +If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. +Otherwise, this function can return: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_NUM\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.PP +Note that if \f[B]bcl_rand_seed2num(\f[R]\f[I]void\f[R]\f[B])\f[R] or +\f[B]bcl_rand_seed2num_err(BclNumber)\f[R] are called right after this +function, they are not guaranteed to return a number equal to +\f[I]n\f[R]. +.RE +.TP +\f[B]BclError bcl_rand_seed(unsigned char\f[R] \f[I]seed\f[R]\f[B][\f[R]\f[I]BC_SEED_SIZE\f[R]\f[B]])\f[R] +Seeds the PRNG with the bytes in \f[I]seed\f[R]. +.RS +.PP +If there was no error, \f[B]BCL_ERROR_NONE\f[R] is returned. +Otherwise, this function can return: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.RE +.TP +\f[B]void bcl_rand_reseed(\f[R]\f[I]void\f[R]\f[B])\f[R] +Reseeds the PRNG with the default reseeding behavior. +First, it attempts to read data from \f[B]/dev/urandom\f[R] and falls +back to \f[B]libc\f[R]\[cq]s \f[B]rand()\f[R]. +.RS +.PP +This procedure cannot fail. +.RE +.TP +\f[B]BclNumber bcl_rand_seed2num(\f[R]\f[I]void\f[R]\f[B])\f[R] +Returns the current seed of the PRNG as a \f[B]BclNumber\f[R]. +.RS +.PP +This procedure requires a valid current context. +.PP +bcl(3) will encode an error in the return value, if there was one. +The error can be queried with \f[B]bcl_err(BclNumber)\f[R]. +Possible errors include: +.IP \[bu] 2 +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +.IP \[bu] 2 +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +.RE +.TP +\f[B]BclRandInt bcl_rand_int(\f[R]\f[I]void\f[R]\f[B])\f[R] +Returns a random integer between \f[B]0\f[R] and \f[B]BC_RAND_MAX\f[R] +(inclusive). +.RS +.PP +This procedure cannot fail. +.RE +.TP +\f[B]BclRandInt bcl_rand_bounded(BclRandInt\f[R] \f[I]bound\f[R]\f[B])\f[R] +Returns a random integer between \f[B]0\f[R] and \f[I]bound\f[R] +(exclusive). +Bias is removed before returning the integer. +.RS +.PP +This procedure cannot fail. +.RE +.SS Consumption and Propagation +.PP +Some functions are listed as consuming some or all of their arguments. +This means that the arguments are freed, regardless of if there were +errors or not. +.PP +This is to enable compact code like the following: +.IP +.nf +\f[C] +BclNumber n = bcl_num_add(bcl_num_mul(a, b), bcl_num_div(c, d)); +\f[R] +.fi +.PP +If arguments to those functions were not consumed, memory would be +leaked until reclaimed with \f[B]bcl_ctxt_freeNums(BclContext)\f[R]. +.PP +When errors occur, they are propagated through. +The result should always be checked with \f[B]bcl_err(BclNumber)\f[R], +so the example above should properly be: +.IP +.nf +\f[C] +BclNumber n = bcl_num_add(bcl_num_mul(a, b), bcl_num_div(c, d)); +if (bc_num_err(n) != BCL_ERROR_NONE) { + // Handle the error. +} +\f[R] +.fi +.SH ERRORS +.PP +Most functions in bcl(3) return, directly or indirectly, any one of the +error codes defined in \f[B]BclError\f[R]. +The complete list of codes is the following: +.TP +\f[B]BCL_ERROR_NONE\f[R] +Success; no error occurred. +.TP +\f[B]BCL_ERROR_INVALID_NUM\f[R] +An invalid \f[B]BclNumber\f[R] was given as a parameter. +.TP +\f[B]BCL_ERROR_INVALID_CONTEXT\f[R] +An invalid \f[B]BclContext\f[R] is being used. +.TP +\f[B]BCL_ERROR_SIGNAL\f[R] +A signal interrupted execution. +.TP +\f[B]BCL_ERROR_MATH_NEGATIVE\f[R] +A negative number was given as an argument to a parameter that cannot +accept negative numbers, such as for square roots. +.TP +\f[B]BCL_ERROR_MATH_NON_INTEGER\f[R] +A non-integer was given as an argument to a parameter that cannot accept +non-integer numbers, such as for the second parameter of +\f[B]bcl_num_pow()\f[R]. +.TP +\f[B]BCL_ERROR_MATH_OVERFLOW\f[R] +A number that would overflow its result was given as an argument, such +as for converting a \f[B]BclNumber\f[R] to a \f[B]BclBigDig\f[R]. +.TP +\f[B]BCL_ERROR_MATH_DIVIDE_BY_ZERO\f[R] +A divide by zero occurred. +.TP +\f[B]BCL_ERROR_PARSE_INVALID_STR\f[R] +An invalid number string was passed to a parsing function. +.RS +.PP +A valid number string can only be one radix (period). +In addition, any lowercase ASCII letters, symbols, or non-ASCII +characters are invalid. +It is allowed for the first character to be a dash. +In that case, the number is considered to be negative. +.PP +There is one exception to the above: one lowercase \f[B]e\f[R] is +allowed in the number, after the radix, if it exists. +If the letter \f[B]e\f[R] exists, the number is considered to be in +scientific notation, where the part before the \f[B]e\f[R] is the +number, and the part after, which must be an integer, is the exponent. +There can be a dash right after the \f[B]e\f[R] to indicate a negative +exponent. +.PP +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and bcl(3) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if bcl(3) is given the number string +\f[B]10e-4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.RE +.TP +\f[B]BCL_ERROR_FATAL_ALLOC_ERR\f[R] +bcl(3) failed to allocate memory. +.RS +.PP +If clients call \f[B]bcl_setAbortOnFatalError()\f[R] with an +\f[B]true\f[R] argument, this error will cause bcl(3) to throw a +\f[B]SIGABRT\f[R]. +This behavior can also be turned off later by calling that same function +with a \f[B]false\f[R] argument. +By default, this behavior is off. +.PP +It is highly recommended that client libraries do \f[I]not\f[R] activate +this behavior. +.RE +.TP +\f[B]BCL_ERROR_FATAL_UNKNOWN_ERR\f[R] +An unknown error occurred. +.RS +.PP +If clients call \f[B]bcl_setAbortOnFatalError()\f[R] with an +\f[B]true\f[R] argument, this error will cause bcl(3) to throw a +\f[B]SIGABRT\f[R]. +This behavior can also be turned off later by calling that same function +with a \f[B]false\f[R] argument. +By default, this behavior is off. +.PP +It is highly recommended that client libraries do \f[I]not\f[R] activate +this behavior. +.RE +.SH ATTRIBUTES +.PP +When \f[B]bcl_handleSignal(\f[R]\f[I]void\f[R]\f[B])\f[R] is used +properly, bcl(3) is async-signal-safe. +.PP +bcl(3) is \f[I]MT-Unsafe\f[R]: it is unsafe to call any functions from +more than one thread. +.SH PERFORMANCE +.PP +Most bc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. +bcl(3) does something different. +.PP +It uses large integers to calculate more than \f[B]1\f[R] decimal digit +at a time. +If built in a environment where \f[B]BC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]BC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. +This value (the number of decimal digits per large integer) is called +\f[B]BC_BASE_DIGS\f[R]. +.PP +In addition, this bcl(3) uses an even larger integer for overflow +checking. +This integer type depends on the value of \f[B]BC_LONG_BIT\f[R], but is +always at least twice as large as the integer type used to store digits. +.SH LIMITS +.PP +The following are the limits on bcl(3): +.TP +\f[B]BC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where +bcl(3) was built. +This determines how many decimal digits can be stored in a single large +integer (see the \f[B]PERFORMANCE\f[R] section). +.TP +\f[B]BC_BASE_DIGS\f[R] +The number of decimal digits per large integer (see the +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]BC_LONG_BIT\f[R]. +.TP +\f[B]BC_BASE_POW\f[R] +The max decimal number that each large integer can store (see +\f[B]BC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]BC_BASE_DIGS\f[R]. +.TP +\f[B]BC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] +section) can hold. +Depends on \f[B]BC_LONG_BIT\f[R]. +.TP +\f[B]BC_BASE_MAX\f[R] +The maximum output base. +Set at \f[B]BC_BASE_POW\f[R]. +.TP +\f[B]BC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. +.TP +\f[B]BC_NUM_MAX\f[R] +The maximum length of a number (in decimal digits), which includes +digits after the decimal point. +Set at \f[B]BC_OVERFLOW_MAX-1\f[R]. +.TP +\f[B]BC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]bcl_rand_int()\f[R] +function. +Set at \f[B]2\[ha]BC_LONG_BIT-1\f[R]. +.TP +Exponent +The maximum allowable exponent (positive or negative). +Set at \f[B]BC_OVERFLOW_MAX\f[R]. +.PP +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. +In fact, memory should be exhausted before these limits should be hit. +.SH SIGNAL HANDLING +.PP +If a signal handler calls +\f[B]bcl_handleSignal(\f[R]\f[I]void\f[R]\f[B])\f[R] from the same +thread that there are bcl(3) functions executing in, it will cause all +execution to stop as soon as possible, interrupting long-running +calculations, if necessary and cause the function that was executing to +return. +If possible, the error code \f[B]BC_ERROR_SIGNAL\f[R] is returned. +.PP +If execution \f[I]is\f[R] interrupted, +\f[B]bcl_handleSignal(\f[R]\f[I]void\f[R]\f[B])\f[R] does \f[I]not\f[R] +return to its caller. +.PP +It is undefined behavior if +\f[B]bcl_handleSignal(\f[R]\f[I]void\f[R]\f[B])\f[R] is called from a +thread that is not executing bcl(3) functions, if bcl(3) functions are +executing. +.SH SEE ALSO +.PP +bc(1) and dc(1) +.SH STANDARDS +.PP +bcl(3) is compliant with the arithmetic defined in the IEEE Std +1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +specification for bc(1). +.PP +Note that the specification explicitly says that bc(1) only accepts +numbers that use a period (\f[B].\f[R]) as a radix point, regardless of +the value of \f[B]LC_NUMERIC\f[R]. +This is also true of bcl(3). +.SH BUGS +.PP +None are known. +Report bugs at https://git.yzena.com/gavin/bc. +.SH AUTHORS +.PP +Gavin D. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/bcl.3.md b/contrib/bc/manuals/bcl.3.md new file mode 100644 index 000000000000..93c98923f083 --- /dev/null +++ b/contrib/bc/manuals/bcl.3.md @@ -0,0 +1,1177 @@ +<!--- + +SPDX-License-Identifier: BSD-2-Clause + +Copyright (c) 2018-2020 Gavin D. Howard and contributors. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +* Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +POSSIBILITY OF SUCH DAMAGE. + +--> + +# NAME + +bcl - library of arbitrary precision decimal arithmetic + +# SYNOPSIS + +## Use + +*#include <bcl.h>* + +Link with *-lbcl*. + +## Signals + +This procedure will allow clients to use signals to interrupt computations +running in bcl(3). + +**void bcl_handleSignal(***void***);** + +**bool bcl_running(***void***);** + +## Setup + +These items allow clients to set up bcl(3). + +**BclError bcl_init(***void***);** + +**void bcl_free(***void***);** + +**bool bcl_abortOnFatalError(***void***);** + +**void bcl_setAbortOnFatalError(bool** *abrt***);** + +**void bcl_gc(***void***);** + +## Contexts + +These items will allow clients to handle contexts, which are isolated from each +other. This allows more than one client to use bcl(3) in the same program. + +**struct BclCtxt;** + +**typedef struct BclCtxt\* BclContext;** + +**BclContext bcl_ctxt_create(***void***);** + +**void bcl_ctxt_free(BclContext** *ctxt***);** + +**BclError bcl_pushContext(BclContext** *ctxt***);** + +**void bcl_popContext(***void***);** + +**BclContext bcl_context(***void***);** + +**void bcl_ctxt_freeNums(BclContext** *ctxt***);** + +**size_t bcl_ctxt_scale(BclContext** *ctxt***);** + +**void bcl_ctxt_setScale(BclContext** *ctxt***, size_t** *scale***);** + +**size_t bcl_ctxt_ibase(BclContext** *ctxt***);** + +**void bcl_ctxt_setIbase(BclContext** *ctxt***, size_t** *ibase***);** + +**size_t bcl_ctxt_obase(BclContext** *ctxt***);** + +**void bcl_ctxt_setObase(BclContext** *ctxt***, size_t** *obase***);** + +## Errors + +These items allow clients to handle errors. + +**typedef enum BclError BclError;** + +**BclError bcl_err(BclNumber** *n***);** + +## Numbers + +These items allow clients to manipulate and query the arbitrary-precision +numbers managed by bcl(3). + +**typedef struct { size_t i; } BclNumber;** + +**BclNumber bcl_num_create(***void***);** + +**void bcl_num_free(BclNumber** *n***);** + +**bool bcl_num_neg(BclNumber** *n***);** + +**void bcl_num_setNeg(BclNumber** *n***, bool** *neg***);** + +**size_t bcl_num_scale(BclNumber** *n***);** + +**BclError bcl_num_setScale(BclNumber** *n***, size_t** *scale***);** + +**size_t bcl_num_len(BclNumber** *n***);** + +## Conversion + +These items allow clients to convert numbers into and from strings and integers. + +**BclNumber bcl_parse(const char \*restrict** *val***);** + +**char\* bcl_string(BclNumber** *n***);** + +**BclError bcl_bigdig(BclNumber** *n***, BclBigDig \****result***);** + +**BclNumber bcl_bigdig2num(BclBigDig** *val***);** + +## Math + +These items allow clients to run math on numbers. + +**BclNumber bcl_add(BclNumber** *a***, BclNumber** *b***);** + +**BclNumber bcl_sub(BclNumber** *a***, BclNumber** *b***);** + +**BclNumber bcl_mul(BclNumber** *a***, BclNumber** *b***);** + +**BclNumber bcl_div(BclNumber** *a***, BclNumber** *b***);** + +**BclNumber bcl_mod(BclNumber** *a***, BclNumber** *b***);** + +**BclNumber bcl_pow(BclNumber** *a***, BclNumber** *b***);** + +**BclNumber bcl_lshift(BclNumber** *a***, BclNumber** *b***);** + +**BclNumber bcl_rshift(BclNumber** *a***, BclNumber** *b***);** + +**BclNumber bcl_sqrt(BclNumber** *a***);** + +**BclError bcl_divmod(BclNumber** *a***, BclNumber** *b***, BclNumber \****c***, BclNumber \****d***);** + +**BclNumber bcl_modexp(BclNumber** *a***, BclNumber** *b***, BclNumber** *c***);** + +## Miscellaneous + +These items are miscellaneous. + +**void bcl_zero(BclNumber** *n***);** + +**void bcl_one(BclNumber** *n***);** + +**ssize_t bcl_cmp(BclNumber** *a***, BclNumber** *b***);** + +**BclError bcl_copy(BclNumber** *d***, BclNumber** *s***);** + +**BclNumber bcl_dup(BclNumber** *s***);** + +## Pseudo-Random Number Generator + +These items allow clients to manipulate the seeded pseudo-random number +generator in bcl(3). + +**#define BCL_SEED_ULONGS** + +**#define BCL_SEED_SIZE** + +**typedef unsigned long BclBigDig;** + +**typedef unsigned long BclRandInt;** + +**BclNumber bcl_irand(BclNumber** *a***);** + +**BclNumber bcl_frand(size_t** *places***);** + +**BclNumber bcl_ifrand(BclNumber** *a***, size_t** *places***);** + +**BclError bcl_rand_seedWithNum(BclNumber** *n***);** + +**BclError bcl_rand_seed(unsigned char** *seed***[***BC_SEED_SIZE***]);** + +**void bcl_rand_reseed(***void***);** + +**BclNumber bcl_rand_seed2num(***void***);** + +**BclRandInt bcl_rand_int(***void***);** + +**BclRandInt bcl_rand_bounded(BclRandInt** *bound***);** + +# DESCRIPTION + +bcl(3) is a library that implements arbitrary-precision decimal math, as +[standardized by POSIX][1] in bc(1). + +bcl(3) is async-signal-safe if **bcl_handleSignal(***void***)** is used +properly. (See the **SIGNAL HANDLING** section.) + +All of the items in its interface are described below. See the documentation for +each function for what each function can return. + +## Signals + +**void bcl_handleSignal(***void***)** + +: An async-signal-safe function that can be called from a signal handler. If + called from a signal handler on the same thread as any executing bcl(3) + functions, it will interrupt the functions and force them to return early. + It is undefined behavior if this function is called from a thread that is + *not* executing any bcl(3) functions while any bcl(3) functions are + executing. + + If execution *is* interrupted, **bcl_handleSignal(***void***)** does *not* + return to its caller. + + See the **SIGNAL HANDLING** section. + +**bool bcl_running(***void***)** + +: An async-signal-safe function that can be called from a signal handler. It + will return **true** if any bcl(3) procedures are running, which means it is + safe to call **bcl_handleSignal(***void***)**. Otherwise, it returns + **false**. + + See the **SIGNAL HANDLING** section. + +## Setup + +**BclError bcl_init(***void***)** + +: Initializes this library. This function can be called multiple times, but + each call must be matched by a call to **bcl_free(***void***)**. This is to + make it possible for multiple libraries and applications to initialize + bcl(3) without problem. + + If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this + function can return: + + * **BCL_ERROR_FATAL_ALLOC_ERR** + + This function must be the first one clients call. Calling any other + function without calling this one first is undefined behavior. + +**void bcl_free(***void***)** + +: Decrements bcl(3)'s reference count and frees the data associated with it if + the reference count is **0**. + + This function must be the last one clients call. Calling this function + before calling any other function is undefined behavior. + +**bool bcl_abortOnFatalError(***void***)** + +: Queries and returns the current state of calling **abort()** on fatal + errors. If **true** is returned, bcl(3) will cause a **SIGABRT** if a fatal + error occurs. + + If activated, clients do not need to check for fatal errors. + +**void bcl_setAbortOnFatalError(bool** *abrt***)** + +: Sets the state of calling **abort()** on fatal errors. If *abrt* is + **false**, bcl(3) will not cause a **SIGABRT** on fatal errors after the + call. If *abrt* is **true**, bcl(3) will cause a **SIGABRT** on fatal errors + after the call. + + If activated, clients do not need to check for fatal errors. + +**void bcl_gc(***void***)** + +: Garbage collects cached instances of arbitrary-precision numbers. This only + frees the memory of numbers that are *not* in use, so it is safe to call at + any time. + +## Contexts + +All procedures that take a **BclContext** parameter a require a valid context as +an argument. + +**struct BclCtxt** + +: A forward declaration for a hidden **struct** type. Clients cannot access + the internals of the **struct** type directly. All interactions with the + type are done through pointers. See **BclContext** below. + +**BclContext** + +: A typedef to a pointer of **struct BclCtxt**. This is the only handle + clients can get to **struct BclCtxt**. + + A **BclContext** contains the values **scale**, **ibase**, and **obase**, as + well as a list of numbers. + + **scale** is a value used to control how many decimal places calculations + should use. A value of **0** means that calculations are done on integers + only, where applicable, and a value of 20, for example, means that all + applicable calculations return results with 20 decimal places. The default + is **0**. + + **ibase** is a value used to control the input base. The minimum **ibase** + is **2**, and the maximum is **36**. If **ibase** is **2**, numbers are + parsed as though they are in binary, and any digits larger than **1** are + clamped. Likewise, a value of **10** means that numbers are parsed as though + they are decimal, and any larger digits are clamped. The default is **10**. + + **obase** is a value used to control the output base. The minimum **obase** + is **0** and the maximum is **BC_BASE_MAX** (see the **LIMITS** section). + + Numbers created in one context are not valid in another context. It is + undefined behavior to use a number created in a different context. Contexts + are meant to isolate the numbers used by different clients in the same + application. + +**BclContext bcl_ctxt_create(***void***)** + +: Creates a context and returns it. Returns **NULL** if there was an error. + +**void bcl_ctxt_free(BclContext** *ctxt***)** + +: Frees *ctxt*, after which it is no longer valid. It is undefined behavior to + attempt to use an invalid context. + +**BclError bcl_pushContext(BclContext** *ctxt***)** + +: Pushes *ctxt* onto bcl(3)'s stack of contexts. *ctxt* must have been created + with **bcl_ctxt_create(***void***)**. + + If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this + function can return: + + * **BCL_ERROR_FATAL_ALLOC_ERR** + + There *must* be a valid context to do any arithmetic. + +**void bcl_popContext(***void***)** + +: Pops the current context off of the stack, if one exists. + +**BclContext bcl_context(***void***)** + +: Returns the current context, or **NULL** if no context exists. + +**void bcl_ctxt_freeNums(BclContext** *ctxt***)** + +: Frees all numbers in use that are associated with *ctxt*. It is undefined + behavior to attempt to use a number associated with *ctxt* after calling + this procedure unless such numbers have been created with + **bcl_num_create(***void***)** after calling this procedure. + +**size_t bcl_ctxt_scale(BclContext** *ctxt***)** + +: Returns the **scale** for given context. + +**void bcl_ctxt_setScale(BclContext** *ctxt***, size_t** *scale***)** + +: Sets the **scale** for the given context to the argument *scale*. + +**size_t bcl_ctxt_ibase(BclContext** *ctxt***)** + +: Returns the **ibase** for the given context. + +**void bcl_ctxt_setIbase(BclContext** *ctxt***, size_t** *ibase***)** + +: Sets the **ibase** for the given context to the argument *ibase*. If the + argument *ibase* is invalid, it clamped, so an *ibase* of **0** or **1** is + clamped to **2**, and any values above **36** are clamped to **36**. + +**size_t bcl_ctxt_obase(BclContext** *ctxt***)** + +: Returns the **obase** for the given context. + +**void bcl_ctxt_setObase(BclContext** *ctxt***, size_t** *obase***)** + +: Sets the **obase** for the given context to the argument *obase*. + +## Errors + +**BclError** + +: An **enum** of possible error codes. See the **ERRORS** section for a + complete listing the codes. + +**BclError bcl_err(BclNumber** *n***)** + +: Checks for errors in a **BclNumber**. All functions that can return a + **BclNumber** can encode an error in the number, and this function will + return the error, if any. If there was no error, it will return + **BCL_ERROR_NONE**. + + There must be a valid current context. + +## Numbers + +All procedures in this section require a valid current context. + +**BclNumber** + +: A handle to an arbitrary-precision number. The actual number type is not + exposed; the **BclNumber** handle is the only way clients can refer to + instances of arbitrary-precision numbers. + +**BclNumber bcl_num_create(***void***)** + +: Creates and returns a **BclNumber**. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**void bcl_num_free(BclNumber** *n***)** + +: Frees *n*. It is undefined behavior to use *n* after calling this function. + +**bool bcl_num_neg(BclNumber** *n***)** + +: Returns **true** if *n* is negative, **false** otherwise. + +**void bcl_num_setNeg(BclNumber** *n***, bool** *neg***)** + +: Sets *n*'s sign to *neg*, where **true** is negative, and **false** is + positive. + +**size_t bcl_num_scale(BclNumber** *n***)** + +: Returns the *scale* of *n*. + + The *scale* of a number is the number of decimal places it has after the + radix (decimal point). + +**BclError bcl_num_setScale(BclNumber** *n***, size_t** *scale***)** + +: Sets the *scale* of *n* to the argument *scale*. If the argument *scale* is + greater than the *scale* of *n*, *n* is extended. If the argument *scale* is + less than the *scale* of *n*, *n* is truncated. + + If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this + function can return: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**size_t bcl_num_len(BclNumber** *n***)** + +: Returns the number of *significant decimal digits* in *n*. + +## Conversion + +All procedures in this section require a valid current context. + +All procedures in this section consume the given **BclNumber** arguments that +are not given to pointer arguments. See the **Consumption and Propagation** +subsection below. + +**BclNumber bcl_parse(const char \*restrict** *val***)** + +: Parses a number string according to the current context's **ibase** and + returns the resulting number. + + *val* must be non-**NULL** and a valid string. See + **BCL_ERROR_PARSE_INVALID_STR** in the **ERRORS** section for more + information. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_PARSE_INVALID_STR** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**char\* bcl_string(BclNumber** *n***)** + +: Returns a string representation of *n* according the the current context's + **ibase**. The string is dynamically allocated and must be freed by the + caller. + + *n* is consumed; it cannot be used after the call. See the + **Consumption and Propagation** subsection below. + +**BclError bcl_bigdig(BclNumber** *n***, BclBigDig \****result***)** + +: Converts *n* into a **BclBigDig** and returns the result in the space + pointed to by *result*. + + *a* must be smaller than **BC_OVERFLOW_MAX**. See the **LIMITS** section. + + If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this + function can return: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_OVERFLOW** + + *n* is consumed; it cannot be used after the call. See the + **Consumption and Propagation** subsection below. + +**BclNumber bcl_bigdig2num(BclBigDig** *val***)** + +: Creates a **BclNumber** from *val*. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +## Math + +All procedures in this section require a valid current context. + +All procedures in this section can return the following errors: + +* **BCL_ERROR_INVALID_NUM** +* **BCL_ERROR_INVALID_CONTEXT** +* **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_add(BclNumber** *a***, BclNumber** *b***)** + +: Adds *a* and *b* and returns the result. The *scale* of the result is the + max of the *scale*s of *a* and *b*. + + *a* and *b* are consumed; they cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + *a* and *b* can be the same number. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_sub(BclNumber** *a***, BclNumber** *b***)** + +: Subtracts *b* from *a* and returns the result. The *scale* of the result is + the max of the *scale*s of *a* and *b*. + + *a* and *b* are consumed; they cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + *a* and *b* can be the same number. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_mul(BclNumber** *a***, BclNumber** *b***)** + +: Multiplies *a* and *b* and returns the result. If *ascale* is the *scale* of + *a* and *bscale* is the *scale* of *b*, the *scale* of the result is equal + to **min(ascale+bscale,max(scale,ascale,bscale))**, where **min()** and + **max()** return the obvious values. + + *a* and *b* are consumed; they cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + *a* and *b* can be the same number. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_div(BclNumber** *a***, BclNumber** *b***)** + +: Divides *a* by *b* and returns the result. The *scale* of the result is the + *scale* of the current context. + + *b* cannot be **0**. + + *a* and *b* are consumed; they cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + *a* and *b* can be the same number. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_DIVIDE_BY_ZERO** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_mod(BclNumber** *a***, BclNumber** *b***)** + +: Divides *a* by *b* to the *scale* of the current context, computes the + modulus **a-(a/b)\*b**, and returns the modulus. + + *b* cannot be **0**. + + *a* and *b* are consumed; they cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + *a* and *b* can be the same number. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_DIVIDE_BY_ZERO** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_pow(BclNumber** *a***, BclNumber** *b***)** + +: Calculates *a* to the power of *b* to the *scale* of the current context. + *b* must be an integer, but can be negative. If it is negative, *a* must + be non-zero. + + *b* must be an integer. If *b* is negative, *a* must not be **0**. + + *a* must be smaller than **BC_OVERFLOW_MAX**. See the **LIMITS** section. + + *a* and *b* are consumed; they cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + *a* and *b* can be the same number. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_NON_INTEGER** + * **BCL_ERROR_MATH_OVERFLOW** + * **BCL_ERROR_MATH_DIVIDE_BY_ZERO** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_lshift(BclNumber** *a***, BclNumber** *b***)** + +: Shifts *a* left (moves the radix right) by *b* places and returns the + result. This is done in decimal. *b* must be an integer. + + *b* must be an integer. + + *a* and *b* are consumed; they cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + *a* and *b* can be the same number. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_NON_INTEGER** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_rshift(BclNumber** *a***, BclNumber** *b***)** + +: Shifts *a* right (moves the radix left) by *b* places and returns the + result. This is done in decimal. *b* must be an integer. + + *b* must be an integer. + + *a* and *b* are consumed; they cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + *a* and *b* can be the same number. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_NON_INTEGER** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_sqrt(BclNumber** *a***)** + +: Calculates the square root of *a* and returns the result. The *scale* of the + result is equal to the **scale** of the current context. + + *a* cannot be negative. + + *a* is consumed; it cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_NEGATIVE** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclError bcl_divmod(BclNumber** *a***, BclNumber** *b***, BclNumber \****c***, BclNumber \****d***)** + +: Divides *a* by *b* and returns the quotient in a new number which is put + into the space pointed to by *c*, and puts the modulus in a new number which + is put into the space pointed to by *d*. + + *b* cannot be **0**. + + *a* and *b* are consumed; they cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + *c* and *d* cannot point to the same place, nor can they point to the space + occupied by *a* or *b*. + + If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this + function can return: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_DIVIDE_BY_ZERO** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_modexp(BclNumber** *a***, BclNumber** *b***, BclNumber** *c***)** + +: Computes a modular exponentiation where *a* is the base, *b* is the + exponent, and *c* is the modulus, and returns the result. The *scale* of the + result is equal to the **scale** of the current context. + + *a*, *b*, and *c* must be integers. *c* must not be **0**. *b* must not be + negative. + + *a*, *b*, and *c* are consumed; they cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_NEGATIVE** + * **BCL_ERROR_MATH_NON_INTEGER** + * **BCL_ERROR_MATH_DIVIDE_BY_ZERO** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +## Miscellaneous + +**void bcl_zero(BclNumber** *n***)** + +: Sets *n* to **0**. + +**void bcl_one(BclNumber** *n***)** + +: Sets *n* to **1**. + +**ssize_t bcl_cmp(BclNumber** *a***, BclNumber** *b***)** + +: Compares *a* and *b* and returns **0** if *a* and *b* are equal, **<0** if + *a* is less than *b*, and **>0** if *a* is greater than *b*. + +**BclError bcl_copy(BclNumber** *d***, BclNumber** *s***)** + +: Copies *s* into *d*. + + If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this + function can return: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_dup(BclNumber** *s***)** + +: Creates and returns a new **BclNumber** that is a copy of *s*. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +## Pseudo-Random Number Generator + +The pseudo-random number generator in bcl(3) is a *seeded* PRNG. Given the same +seed twice, it will produce the same sequence of pseudo-random numbers twice. + +By default, bcl(3) attempts to seed the PRNG with data from **/dev/urandom**. If +that fails, it seeds itself with by calling **libc**'s **srand(time(NULL))** and +then calling **rand()** for each byte, since **rand()** is only guaranteed to +return **15** bits. + +This should provide fairly good seeding in the standard case while also +remaining fairly portable. + +If necessary, the PRNG can be reseeded with one of the following functions: + +* **bcl_rand_seedWithNum(BclNumber)** +* **bcl_rand_seed(unsigned char[BC_SEED_SIZE])** +* **bcl_rand_reseed(***void***)** + +The following items allow clients to use the pseudo-random number generator. All +procedures require a valid current context. + +**BCL_SEED_ULONGS** + +: The number of **unsigned long**'s in a seed for bcl(3)'s random number + generator. + +**BCL_SEED_SIZE** + +: The size, in **char**'s, of a seed for bcl(3)'s random number generator. + +**BclBigDig** + +: bcl(3)'s overflow type (see the **PERFORMANCE** section). + +**BclRandInt** + +: An unsigned integer type returned by bcl(3)'s random number generator. + +**BclNumber bcl_irand(BclNumber** *a***)** + +: Returns a random number that is not larger than *a* in a new number. If *a* + is **0** or **1**, the new number is equal to **0**. The bound is unlimited, + so it is not bound to the size of **BclRandInt**. This is done by generating + as many random numbers as necessary, multiplying them by certain exponents, + and adding them all together. + + *a* must be an integer and non-negative. + + *a* is consumed; it cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + This procedure requires a valid current context. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_NEGATIVE** + * **BCL_ERROR_MATH_NON_INTEGER** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_frand(size_t** *places***)** + +: Returns a random number between **0** (inclusive) and **1** (exclusive) that + has *places* decimal digits after the radix (decimal point). There are no + limits on *places*. + + This procedure requires a valid current context. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclNumber bcl_ifrand(BclNumber** *a***, size_t** *places***)** + +: Returns a random number less than *a* with *places* decimal digits after the + radix (decimal point). There are no limits on *a* or *places*. + + *a* must be an integer and non-negative. + + *a* is consumed; it cannot be used after the call. See the + **Consumption and Propagation** subsection below. + + This procedure requires a valid current context. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_MATH_NEGATIVE** + * **BCL_ERROR_MATH_NON_INTEGER** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclError bcl_rand_seedWithNum(BclNumber** *n***)** + +: Seeds the PRNG with *n*. + + *n* is *not* consumed. + + This procedure requires a valid current context. + + If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this + function can return: + + * **BCL_ERROR_INVALID_NUM** + * **BCL_ERROR_INVALID_CONTEXT** + + Note that if **bcl_rand_seed2num(***void***)** or + **bcl_rand_seed2num_err(BclNumber)** are called right after this function, + they are not guaranteed to return a number equal to *n*. + +**BclError bcl_rand_seed(unsigned char** *seed***[***BC_SEED_SIZE***])** + +: Seeds the PRNG with the bytes in *seed*. + + If there was no error, **BCL_ERROR_NONE** is returned. Otherwise, this + function can return: + + * **BCL_ERROR_INVALID_CONTEXT** + +**void bcl_rand_reseed(***void***)** + +: Reseeds the PRNG with the default reseeding behavior. First, it attempts to + read data from **/dev/urandom** and falls back to **libc**'s **rand()**. + + This procedure cannot fail. + +**BclNumber bcl_rand_seed2num(***void***)** + +: Returns the current seed of the PRNG as a **BclNumber**. + + This procedure requires a valid current context. + + bcl(3) will encode an error in the return value, if there was one. The error + can be queried with **bcl_err(BclNumber)**. Possible errors include: + + * **BCL_ERROR_INVALID_CONTEXT** + * **BCL_ERROR_FATAL_ALLOC_ERR** + +**BclRandInt bcl_rand_int(***void***)** + +: Returns a random integer between **0** and **BC_RAND_MAX** (inclusive). + + This procedure cannot fail. + +**BclRandInt bcl_rand_bounded(BclRandInt** *bound***)** + +: Returns a random integer between **0** and *bound* (exclusive). Bias is + removed before returning the integer. + + This procedure cannot fail. + +## Consumption and Propagation + +Some functions are listed as consuming some or all of their arguments. This +means that the arguments are freed, regardless of if there were errors or not. + +This is to enable compact code like the following: + + BclNumber n = bcl_num_add(bcl_num_mul(a, b), bcl_num_div(c, d)); + +If arguments to those functions were not consumed, memory would be leaked until +reclaimed with **bcl_ctxt_freeNums(BclContext)**. + +When errors occur, they are propagated through. The result should always be +checked with **bcl_err(BclNumber)**, so the example above should properly +be: + + BclNumber n = bcl_num_add(bcl_num_mul(a, b), bcl_num_div(c, d)); + if (bc_num_err(n) != BCL_ERROR_NONE) { + // Handle the error. + } + +# ERRORS + +Most functions in bcl(3) return, directly or indirectly, any one of the error +codes defined in **BclError**. The complete list of codes is the following: + +**BCL_ERROR_NONE** + +: Success; no error occurred. + +**BCL_ERROR_INVALID_NUM** + +: An invalid **BclNumber** was given as a parameter. + +**BCL_ERROR_INVALID_CONTEXT** + +: An invalid **BclContext** is being used. + +**BCL_ERROR_SIGNAL** + +: A signal interrupted execution. + +**BCL_ERROR_MATH_NEGATIVE** + +: A negative number was given as an argument to a parameter that cannot accept + negative numbers, such as for square roots. + +**BCL_ERROR_MATH_NON_INTEGER** + +: A non-integer was given as an argument to a parameter that cannot accept + non-integer numbers, such as for the second parameter of **bcl_num_pow()**. + +**BCL_ERROR_MATH_OVERFLOW** + +: A number that would overflow its result was given as an argument, such as + for converting a **BclNumber** to a **BclBigDig**. + +**BCL_ERROR_MATH_DIVIDE_BY_ZERO** + +: A divide by zero occurred. + +**BCL_ERROR_PARSE_INVALID_STR** + +: An invalid number string was passed to a parsing function. + + A valid number string can only be one radix (period). In addition, any + lowercase ASCII letters, symbols, or non-ASCII characters are invalid. It is + allowed for the first character to be a dash. In that case, the number is + considered to be negative. + + There is one exception to the above: one lowercase **e** is allowed in the + number, after the radix, if it exists. If the letter **e** exists, the + number is considered to be in scientific notation, where the part before the + **e** is the number, and the part after, which must be an integer, is the + exponent. There can be a dash right after the **e** to indicate a negative + exponent. + + **WARNING**: Both the number and the exponent in scientific notation are + interpreted according to the current **ibase**, but the number is still + multiplied by **10\^exponent** regardless of the current **ibase**. For + example, if **ibase** is **16** and bcl(3) is given the number string + **FFeA**, the resulting decimal number will be **2550000000000**, and if + bcl(3) is given the number string **10e-4**, the resulting decimal number + will be **0.0016**. + +**BCL_ERROR_FATAL_ALLOC_ERR** + +: bcl(3) failed to allocate memory. + + If clients call **bcl_setAbortOnFatalError()** with an **true** argument, + this error will cause bcl(3) to throw a **SIGABRT**. This behavior can also + be turned off later by calling that same function with a **false** argument. + By default, this behavior is off. + + It is highly recommended that client libraries do *not* activate this + behavior. + +**BCL_ERROR_FATAL_UNKNOWN_ERR** + +: An unknown error occurred. + + If clients call **bcl_setAbortOnFatalError()** with an **true** argument, + this error will cause bcl(3) to throw a **SIGABRT**. This behavior can also + be turned off later by calling that same function with a **false** argument. + By default, this behavior is off. + + It is highly recommended that client libraries do *not* activate this + behavior. + +# ATTRIBUTES + +When **bcl_handleSignal(***void***)** is used properly, bcl(3) is +async-signal-safe. + +bcl(3) is *MT-Unsafe*: it is unsafe to call any functions from more than one +thread. + +# PERFORMANCE + +Most bc(1) implementations use **char** types to calculate the value of **1** +decimal digit at a time, but that can be slow. bcl(3) does something +different. + +It uses large integers to calculate more than **1** decimal digit at a time. If +built in a environment where **BC_LONG_BIT** (see the **LIMITS** section) is +**64**, then each integer has **9** decimal digits. If built in an environment +where **BC_LONG_BIT** is **32** then each integer has **4** decimal digits. This +value (the number of decimal digits per large integer) is called +**BC_BASE_DIGS**. + +In addition, this bcl(3) uses an even larger integer for overflow checking. This +integer type depends on the value of **BC_LONG_BIT**, but is always at least +twice as large as the integer type used to store digits. + +# LIMITS + +The following are the limits on bcl(3): + +**BC_LONG_BIT** + +: The number of bits in the **long** type in the environment where bcl(3) was + built. This determines how many decimal digits can be stored in a single + large integer (see the **PERFORMANCE** section). + +**BC_BASE_DIGS** + +: The number of decimal digits per large integer (see the **PERFORMANCE** + section). Depends on **BC_LONG_BIT**. + +**BC_BASE_POW** + +: The max decimal number that each large integer can store (see + **BC_BASE_DIGS**) plus **1**. Depends on **BC_BASE_DIGS**. + +**BC_OVERFLOW_MAX** + +: The max number that the overflow type (see the **PERFORMANCE** section) can + hold. Depends on **BC_LONG_BIT**. + +**BC_BASE_MAX** + +: The maximum output base. Set at **BC_BASE_POW**. + +**BC_SCALE_MAX** + +: The maximum **scale**. Set at **BC_OVERFLOW_MAX-1**. + +**BC_NUM_MAX** + +: The maximum length of a number (in decimal digits), which includes digits + after the decimal point. Set at **BC_OVERFLOW_MAX-1**. + +**BC_RAND_MAX** + +: The maximum integer (inclusive) returned by the **bcl_rand_int()** function. + Set at **2\^BC_LONG_BIT-1**. + +Exponent + +: The maximum allowable exponent (positive or negative). Set at + **BC_OVERFLOW_MAX**. + +These limits are meant to be effectively non-existent; the limits are so large +(at least on 64-bit machines) that there should not be any point at which they +become a problem. In fact, memory should be exhausted before these limits should +be hit. + +# SIGNAL HANDLING + +If a signal handler calls **bcl_handleSignal(***void***)** from the same thread +that there are bcl(3) functions executing in, it will cause all execution to +stop as soon as possible, interrupting long-running calculations, if necessary +and cause the function that was executing to return. If possible, the error code +**BC_ERROR_SIGNAL** is returned. + +If execution *is* interrupted, **bcl_handleSignal(***void***)** does *not* +return to its caller. + +It is undefined behavior if **bcl_handleSignal(***void***)** is called from +a thread that is not executing bcl(3) functions, if bcl(3) functions are +executing. + +# SEE ALSO + +bc(1) and dc(1) + +# STANDARDS + +bcl(3) is compliant with the arithmetic defined in the +[IEEE Std 1003.1-2017 (“POSIX.1-2017”)][1] specification for bc(1). + +Note that the specification explicitly says that bc(1) only accepts numbers that +use a period (**.**) as a radix point, regardless of the value of +**LC_NUMERIC**. This is also true of bcl(3). + +# BUGS + +None are known. Report bugs at https://git.yzena.com/gavin/bc. + +# AUTHORS + +Gavin D. Howard <gavin@yzena.com> and contributors. + +[1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/build.md b/contrib/bc/manuals/build.md index 906551cc73ac..47fbabdfad7f 100644 --- a/contrib/bc/manuals/build.md +++ b/contrib/bc/manuals/build.md @@ -282,6 +282,29 @@ following forms: --option=arg ``` +### Library + +To build the math library, use the following commands for the configure step: + +``` +./configure.sh -a +./configure.sh --library +``` + +Both commands are equivalent. + +When the library is built, history, prompt, and locales are disabled, and the +functionality for `bc` and `dc` are both enabled, though the executables are +*not* built. This is because the library's options clash with the executables. + +To build an optimized version of the library, users can pass optimization +options to `configure.sh` or include them in `CFLAGS`. + +The library API can be found in `manuals/bcl.3.md` or `man bcl` once the library +is installed. + +The library is built as `bin/libbcl.a`. + ### `bc` Only To build `bc` only (no `dc`), use any one of the following commands for the diff --git a/contrib/bc/manuals/dc.1.md.in b/contrib/bc/manuals/dc.1.md.in index abb1c4aac773..5308b1c604a5 100644 --- a/contrib/bc/manuals/dc.1.md.in +++ b/contrib/bc/manuals/dc.1.md.in @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -235,9 +235,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that {{ A H N P HN HP NP HNP }} In addition, dc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still @@ -355,7 +355,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1252,6 +1253,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/A.1 b/contrib/bc/manuals/dc/A.1 index 001fe5a1f2c5..c993afb1fd4e 100644 --- a/contrib/bc/manuals/dc/A.1 +++ b/contrib/bc/manuals/dc/A.1 @@ -25,92 +25,90 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in -\f[B]DC_ENV_ARGS\f[]. +\f[B]DC_ENV_ARGS\f[R]. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -119,165 +117,167 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. -.PP -\f[B]seed\f[] is a register containing the current seed for the -pseudo\-random number generator. -If the current value of \f[B]seed\f[] is queried and stored, then if it -is assigned to \f[B]seed\f[] later, the pseudo\-random number generator -is guaranteed to produce the same sequence of pseudo\-random numbers -that were generated after the value of \f[B]seed\f[] was first queried. -.PP -Multiple values assigned to \f[B]seed\f[] can produce the same sequence -of pseudo\-random numbers. -Likewise, when a value is assigned to \f[B]seed\f[], it is not -guaranteed that querying \f[B]seed\f[] immediately after will return the -same value. -In addition, the value of \f[B]seed\f[] will change after any call to -the \f[B]\[aq]\f[] command or the \f[B]"\f[] command that does not get -receive a value of \f[B]0\f[] or \f[B]1\f[]. -The maximum integer returned by the \f[B]\[aq]\f[] command can be -queried with the \f[B]W\f[] command. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with the \f[B]\[aq]\f[] and \f[B]"\f[] commands are guaranteed -to \f[B]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[B]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. -.PP -The pseudo\-random number generator, \f[B]seed\f[], and all associated -operations are \f[B]non\-portable extensions\f[]. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. +.PP +\f[B]seed\f[R] is a register containing the current seed for the +pseudo-random number generator. +If the current value of \f[B]seed\f[R] is queried and stored, then if it +is assigned to \f[B]seed\f[R] later, the pseudo-random number generator +is guaranteed to produce the same sequence of pseudo-random numbers that +were generated after the value of \f[B]seed\f[R] was first queried. +.PP +Multiple values assigned to \f[B]seed\f[R] can produce the same sequence +of pseudo-random numbers. +Likewise, when a value is assigned to \f[B]seed\f[R], it is not +guaranteed that querying \f[B]seed\f[R] immediately after will return +the same value. +In addition, the value of \f[B]seed\f[R] will change after any call to +the \f[B]\[cq]\f[R] command or the \f[B]\[dq]\f[R] command that does not +get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. +The maximum integer returned by the \f[B]\[cq]\f[R] command can be +queried with the \f[B]W\f[R] command. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with the \f[B]\[cq]\f[R] and \f[B]\[dq]\f[R] commands are +guaranteed to \f[B]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[B]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. +.PP +The pseudo-random number generator, \f[B]seed\f[R], and all associated +operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e_3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and dc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if dc(1) is given the number string -\f[B]10e_4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if dc(1) is given the number string +\f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -287,15 +287,16 @@ These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[] using \f[B]0o\f[], and engineering notation is activated -by assigning \f[B]1\f[] to \f[B]obase\f[] using \f[B]1o\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is +activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using +\f[B]1o\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -303,27 +304,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -334,461 +333,434 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]H\f[] +\f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]h\f[] +\f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE -.SS Pseudo\-Random Number Generator +.SS Pseudo-Random Number Generator .PP -dc(1) has a built\-in pseudo\-random number generator. -These commands query the pseudo\-random number generator. -(See Parameters for more information about the \f[B]seed\f[] value that -controls the pseudo\-random number generator.) +dc(1) has a built-in pseudo-random number generator. +These commands query the pseudo-random number generator. +(See Parameters for more information about the \f[B]seed\f[R] value that +controls the pseudo-random number generator.) .PP -The pseudo\-random number generator is guaranteed to \f[B]NOT\f[] be +The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP -.B \f[B]\[aq]\f[] -Generates an integer between 0 and \f[B]DC_RAND_MAX\f[], inclusive (see -the \f[B]LIMITS\f[] section). +\f[B]\[cq]\f[R] +Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see +the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]"\f[] -Pops a value off of the stack, which is used as an \f[B]exclusive\f[] +\f[B]\[dq]\f[R] +Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. -If the bound is negative or is a non\-integer, an error is raised, and -dc(1) resets (see the \f[B]RESET\f[] section) while \f[B]seed\f[] +If the bound is negative or is a non-integer, an error is raised, and +dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. -If the bound is larger than \f[B]DC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]DC_RAND_MAX+1\f[], and adding them +If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. -Using this command will change the value of \f[B]seed\f[], unless the -operand is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is pushed onto the stack, and \f[B]seed\f[] is -\f[I]not\f[] changed. +Using this command will change the value of \f[B]seed\f[R], unless the +operand is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] +is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], -\f[B]scale\f[], and \f[B]seed\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +\f[B]scale\f[R], and \f[B]seed\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]0\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section and the -\f[B]NUMBERS\f[] section). +\f[B]obase\f[R], which must be between \f[B]0\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and +the \f[B]NUMBERS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]j\f[] +\f[B]j\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]seed\f[]. -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +\f[B]seed\f[R]. +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP -The \f[I]scale\f[] and sign of the value may be significant. +The \f[I]scale\f[R] and sign of the value may be significant. .PP -If a previously used \f[B]seed\f[] value is used again, the -pseudo\-random number generator is guaranteed to produce the same -sequence of pseudo\-random numbers as it did when the \f[B]seed\f[] +If a previously used \f[B]seed\f[R] value is used again, the +pseudo-random number generator is guaranteed to produce the same +sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if the \f[B]J\f[] command is used. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will not -produce unique sequences of pseudo\-random numbers. +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if the \f[B]J\f[R] command is used. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will not +produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]J\f[] -Pushes the current value of \f[B]seed\f[] onto the main stack. +\f[B]J\f[R] +Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]W\f[] +\f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the -\f[B]\[aq]\f[] pseudo\-random number generator command. +\f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -796,18 +768,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -815,26 +787,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -846,160 +818,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -1009,37 +975,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -1047,31 +1007,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1084,261 +1044,228 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]\[aq]\f[] command, +\f[B]DC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). -Set at \f[B]2^DC_LONG_BIT\-1\f[]. -.RS -.RE +Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]H\f[]), and -right shift (\f[B]h\f[]) operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP The prompt is enabled in TTY mode. @@ -1346,56 +1273,56 @@ The prompt is enabled in TTY mode. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when dc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause dc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when dc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -dc(1) supports interactive command\-line editing. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +dc(1) supports interactive command-line editing. +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGS\f[]. +locales and thus, supports \f[B]LC_MESSAGS\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1404,4 +1331,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/A.1.md b/contrib/bc/manuals/dc/A.1.md index 50c7c8f08c6b..d48b2429aaa2 100644 --- a/contrib/bc/manuals/dc/A.1.md +++ b/contrib/bc/manuals/dc/A.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -222,9 +222,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **15**. In addition, dc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still @@ -339,7 +339,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1189,6 +1190,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/E.1 b/contrib/bc/manuals/dc/E.1 index f5b1f194f206..1e04920d51fd 100644 --- a/contrib/bc/manuals/dc/E.1 +++ b/contrib/bc/manuals/dc/E.1 @@ -25,92 +25,90 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in -\f[B]DC_ENV_ARGS\f[]. +\f[B]DC_ENV_ARGS\f[R]. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -119,112 +117,113 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -232,7 +231,7 @@ The valid commands are listed below. .PP These commands are used for printing. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -240,27 +239,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -271,330 +268,303 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], and -\f[B]scale\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +and \f[B]scale\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]2\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section). +\f[B]obase\f[R], which must be between \f[B]2\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -602,18 +572,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -621,26 +591,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -652,160 +622,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -815,37 +779,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -853,31 +811,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -890,251 +848,220 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator. +power (\f[B]\[ha]\f[R]) operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP The prompt is enabled in TTY mode. @@ -1142,56 +1069,56 @@ The prompt is enabled in TTY mode. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when dc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause dc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when dc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -dc(1) supports interactive command\-line editing. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +dc(1) supports interactive command-line editing. +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGS\f[]. +locales and thus, supports \f[B]LC_MESSAGS\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1200,4 +1127,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/E.1.md b/contrib/bc/manuals/dc/E.1.md index bb2ab4b0366d..3ccf45a98ae3 100644 --- a/contrib/bc/manuals/dc/E.1.md +++ b/contrib/bc/manuals/dc/E.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -289,7 +289,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1025,6 +1026,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/EH.1 b/contrib/bc/manuals/dc/EH.1 index 9c5cf7d14c92..5ccc64ea725e 100644 --- a/contrib/bc/manuals/dc/EH.1 +++ b/contrib/bc/manuals/dc/EH.1 @@ -25,92 +25,90 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in -\f[B]DC_ENV_ARGS\f[]. +\f[B]DC_ENV_ARGS\f[R]. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -119,112 +117,113 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -232,7 +231,7 @@ The valid commands are listed below. .PP These commands are used for printing. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -240,27 +239,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -271,330 +268,303 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], and -\f[B]scale\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +and \f[B]scale\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]2\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section). +\f[B]obase\f[R], which must be between \f[B]2\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -602,18 +572,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -621,26 +591,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -652,160 +622,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -815,37 +779,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -853,31 +811,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -890,293 +848,262 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator. +power (\f[B]\[ha]\f[R]) operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP The prompt is enabled in TTY mode. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGS\f[]. +locales and thus, supports \f[B]LC_MESSAGS\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1185,4 +1112,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/EH.1.md b/contrib/bc/manuals/dc/EH.1.md index e1a0540d1243..b59a5ef71a0c 100644 --- a/contrib/bc/manuals/dc/EH.1.md +++ b/contrib/bc/manuals/dc/EH.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -289,7 +289,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1012,6 +1013,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/EHN.1 b/contrib/bc/manuals/dc/EHN.1 index 4d95b4a1ac96..bce6e577df6c 100644 --- a/contrib/bc/manuals/dc/EHN.1 +++ b/contrib/bc/manuals/dc/EHN.1 @@ -25,92 +25,90 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in -\f[B]DC_ENV_ARGS\f[]. +\f[B]DC_ENV_ARGS\f[R]. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -119,112 +117,113 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -232,7 +231,7 @@ The valid commands are listed below. .PP These commands are used for printing. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -240,27 +239,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -271,330 +268,303 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], and -\f[B]scale\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +and \f[B]scale\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]2\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section). +\f[B]obase\f[R], which must be between \f[B]2\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -602,18 +572,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -621,26 +591,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -652,160 +622,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -815,37 +779,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -853,31 +811,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -890,289 +848,258 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator. +power (\f[B]\[ha]\f[R]) operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP The prompt is enabled in TTY mode. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1181,4 +1108,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/EHN.1.md b/contrib/bc/manuals/dc/EHN.1.md index 1fe5ab8cac09..fd1a0251fd04 100644 --- a/contrib/bc/manuals/dc/EHN.1.md +++ b/contrib/bc/manuals/dc/EHN.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -289,7 +289,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1007,6 +1008,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/EHNP.1 b/contrib/bc/manuals/dc/EHNP.1 index aceea91027ad..98cdfd150436 100644 --- a/contrib/bc/manuals/dc/EHNP.1 +++ b/contrib/bc/manuals/dc/EHNP.1 @@ -25,87 +25,85 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -114,112 +112,113 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -227,7 +226,7 @@ The valid commands are listed below. .PP These commands are used for printing. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -235,27 +234,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -266,330 +263,303 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], and -\f[B]scale\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +and \f[B]scale\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]2\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section). +\f[B]obase\f[R], which must be between \f[B]2\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -597,18 +567,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -616,26 +586,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -647,160 +617,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -810,37 +774,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -848,31 +806,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -885,287 +843,256 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator. +power (\f[B]\[ha]\f[R]) operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1174,4 +1101,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/EHNP.1.md b/contrib/bc/manuals/dc/EHNP.1.md index 97585bba14bb..c1d7457770e8 100644 --- a/contrib/bc/manuals/dc/EHNP.1.md +++ b/contrib/bc/manuals/dc/EHNP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -286,7 +286,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1002,6 +1003,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/EHP.1 b/contrib/bc/manuals/dc/EHP.1 index 70e45ae52363..5f930f841aa4 100644 --- a/contrib/bc/manuals/dc/EHP.1 +++ b/contrib/bc/manuals/dc/EHP.1 @@ -25,87 +25,85 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -114,112 +112,113 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -227,7 +226,7 @@ The valid commands are listed below. .PP These commands are used for printing. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -235,27 +234,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -266,330 +263,303 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], and -\f[B]scale\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +and \f[B]scale\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]2\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section). +\f[B]obase\f[R], which must be between \f[B]2\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -597,18 +567,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -616,26 +586,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -647,160 +617,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -810,37 +774,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -848,31 +806,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -885,291 +843,260 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator. +power (\f[B]\[ha]\f[R]) operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGS\f[]. +locales and thus, supports \f[B]LC_MESSAGS\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1178,4 +1105,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/EHP.1.md b/contrib/bc/manuals/dc/EHP.1.md index d101695a1c89..2df787cef087 100644 --- a/contrib/bc/manuals/dc/EHP.1.md +++ b/contrib/bc/manuals/dc/EHP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -286,7 +286,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1007,6 +1008,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/EN.1 b/contrib/bc/manuals/dc/EN.1 index 4c57b0dd03e3..561a0f665cfc 100644 --- a/contrib/bc/manuals/dc/EN.1 +++ b/contrib/bc/manuals/dc/EN.1 @@ -25,92 +25,90 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in -\f[B]DC_ENV_ARGS\f[]. +\f[B]DC_ENV_ARGS\f[R]. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -119,112 +117,113 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -232,7 +231,7 @@ The valid commands are listed below. .PP These commands are used for printing. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -240,27 +239,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -271,330 +268,303 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], and -\f[B]scale\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +and \f[B]scale\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]2\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section). +\f[B]obase\f[R], which must be between \f[B]2\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -602,18 +572,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -621,26 +591,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -652,160 +622,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -815,37 +779,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -853,31 +811,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -890,251 +848,220 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator. +power (\f[B]\[ha]\f[R]) operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP The prompt is enabled in TTY mode. @@ -1142,52 +1069,52 @@ The prompt is enabled in TTY mode. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when dc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause dc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when dc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -dc(1) supports interactive command\-line editing. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +dc(1) supports interactive command-line editing. +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1196,4 +1123,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/EN.1.md b/contrib/bc/manuals/dc/EN.1.md index e1826daa4e18..01c40a8e34dc 100644 --- a/contrib/bc/manuals/dc/EN.1.md +++ b/contrib/bc/manuals/dc/EN.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -289,7 +289,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1020,6 +1021,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/ENP.1 b/contrib/bc/manuals/dc/ENP.1 index 2e8e2341a739..77a94af08310 100644 --- a/contrib/bc/manuals/dc/ENP.1 +++ b/contrib/bc/manuals/dc/ENP.1 @@ -25,87 +25,85 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -114,112 +112,113 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -227,7 +226,7 @@ The valid commands are listed below. .PP These commands are used for printing. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -235,27 +234,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -266,330 +263,303 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], and -\f[B]scale\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +and \f[B]scale\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]2\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section). +\f[B]obase\f[R], which must be between \f[B]2\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -597,18 +567,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -616,26 +586,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -647,160 +617,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -810,37 +774,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -848,31 +806,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -885,302 +843,271 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator. +power (\f[B]\[ha]\f[R]) operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when dc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause dc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when dc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -dc(1) supports interactive command\-line editing. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +dc(1) supports interactive command-line editing. +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1189,4 +1116,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/ENP.1.md b/contrib/bc/manuals/dc/ENP.1.md index cc5eea424fb2..9eb8696d1755 100644 --- a/contrib/bc/manuals/dc/ENP.1.md +++ b/contrib/bc/manuals/dc/ENP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -286,7 +286,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1015,6 +1016,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/EP.1 b/contrib/bc/manuals/dc/EP.1 index f97f2a8ae98f..9a41956d67a5 100644 --- a/contrib/bc/manuals/dc/EP.1 +++ b/contrib/bc/manuals/dc/EP.1 @@ -25,87 +25,85 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -114,112 +112,113 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]2\f[]. +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]2\f[R]. Values are output in the specified base. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -227,7 +226,7 @@ The valid commands are listed below. .PP These commands are used for printing. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -235,27 +234,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -266,330 +263,303 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], and -\f[B]scale\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +and \f[B]scale\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]2\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section). +\f[B]obase\f[R], which must be between \f[B]2\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -597,18 +567,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -616,26 +586,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -647,160 +617,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -810,37 +774,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -848,31 +806,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -885,306 +843,275 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware integer, and -attempting to use a non\-integer where an integer is required. +attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]) operator. +power (\f[B]\[ha]\f[R]) operator. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when dc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause dc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when dc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -dc(1) supports interactive command\-line editing. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +dc(1) supports interactive command-line editing. +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGS\f[]. +locales and thus, supports \f[B]LC_MESSAGS\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1193,4 +1120,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/EP.1.md b/contrib/bc/manuals/dc/EP.1.md index cd58549b17a5..f9333fd29e19 100644 --- a/contrib/bc/manuals/dc/EP.1.md +++ b/contrib/bc/manuals/dc/EP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -286,7 +286,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1020,6 +1021,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/H.1 b/contrib/bc/manuals/dc/H.1 index 44617c0b1a3c..78f0f55603aa 100644 --- a/contrib/bc/manuals/dc/H.1 +++ b/contrib/bc/manuals/dc/H.1 @@ -25,92 +25,90 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in -\f[B]DC_ENV_ARGS\f[]. +\f[B]DC_ENV_ARGS\f[R]. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -119,165 +117,167 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. -.PP -\f[B]seed\f[] is a register containing the current seed for the -pseudo\-random number generator. -If the current value of \f[B]seed\f[] is queried and stored, then if it -is assigned to \f[B]seed\f[] later, the pseudo\-random number generator -is guaranteed to produce the same sequence of pseudo\-random numbers -that were generated after the value of \f[B]seed\f[] was first queried. -.PP -Multiple values assigned to \f[B]seed\f[] can produce the same sequence -of pseudo\-random numbers. -Likewise, when a value is assigned to \f[B]seed\f[], it is not -guaranteed that querying \f[B]seed\f[] immediately after will return the -same value. -In addition, the value of \f[B]seed\f[] will change after any call to -the \f[B]\[aq]\f[] command or the \f[B]"\f[] command that does not get -receive a value of \f[B]0\f[] or \f[B]1\f[]. -The maximum integer returned by the \f[B]\[aq]\f[] command can be -queried with the \f[B]W\f[] command. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with the \f[B]\[aq]\f[] and \f[B]"\f[] commands are guaranteed -to \f[B]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[B]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. -.PP -The pseudo\-random number generator, \f[B]seed\f[], and all associated -operations are \f[B]non\-portable extensions\f[]. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. +.PP +\f[B]seed\f[R] is a register containing the current seed for the +pseudo-random number generator. +If the current value of \f[B]seed\f[R] is queried and stored, then if it +is assigned to \f[B]seed\f[R] later, the pseudo-random number generator +is guaranteed to produce the same sequence of pseudo-random numbers that +were generated after the value of \f[B]seed\f[R] was first queried. +.PP +Multiple values assigned to \f[B]seed\f[R] can produce the same sequence +of pseudo-random numbers. +Likewise, when a value is assigned to \f[B]seed\f[R], it is not +guaranteed that querying \f[B]seed\f[R] immediately after will return +the same value. +In addition, the value of \f[B]seed\f[R] will change after any call to +the \f[B]\[cq]\f[R] command or the \f[B]\[dq]\f[R] command that does not +get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. +The maximum integer returned by the \f[B]\[cq]\f[R] command can be +queried with the \f[B]W\f[R] command. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with the \f[B]\[cq]\f[R] and \f[B]\[dq]\f[R] commands are +guaranteed to \f[B]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[B]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. +.PP +The pseudo-random number generator, \f[B]seed\f[R], and all associated +operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e_3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and dc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if dc(1) is given the number string -\f[B]10e_4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if dc(1) is given the number string +\f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -287,15 +287,16 @@ These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[] using \f[B]0o\f[], and engineering notation is activated -by assigning \f[B]1\f[] to \f[B]obase\f[] using \f[B]1o\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is +activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using +\f[B]1o\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -303,27 +304,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -334,461 +333,434 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]H\f[] +\f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]h\f[] +\f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE -.SS Pseudo\-Random Number Generator +.SS Pseudo-Random Number Generator .PP -dc(1) has a built\-in pseudo\-random number generator. -These commands query the pseudo\-random number generator. -(See Parameters for more information about the \f[B]seed\f[] value that -controls the pseudo\-random number generator.) +dc(1) has a built-in pseudo-random number generator. +These commands query the pseudo-random number generator. +(See Parameters for more information about the \f[B]seed\f[R] value that +controls the pseudo-random number generator.) .PP -The pseudo\-random number generator is guaranteed to \f[B]NOT\f[] be +The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP -.B \f[B]\[aq]\f[] -Generates an integer between 0 and \f[B]DC_RAND_MAX\f[], inclusive (see -the \f[B]LIMITS\f[] section). +\f[B]\[cq]\f[R] +Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see +the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]"\f[] -Pops a value off of the stack, which is used as an \f[B]exclusive\f[] +\f[B]\[dq]\f[R] +Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. -If the bound is negative or is a non\-integer, an error is raised, and -dc(1) resets (see the \f[B]RESET\f[] section) while \f[B]seed\f[] +If the bound is negative or is a non-integer, an error is raised, and +dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. -If the bound is larger than \f[B]DC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]DC_RAND_MAX+1\f[], and adding them +If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. -Using this command will change the value of \f[B]seed\f[], unless the -operand is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is pushed onto the stack, and \f[B]seed\f[] is -\f[I]not\f[] changed. +Using this command will change the value of \f[B]seed\f[R], unless the +operand is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] +is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], -\f[B]scale\f[], and \f[B]seed\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +\f[B]scale\f[R], and \f[B]seed\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]0\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section and the -\f[B]NUMBERS\f[] section). +\f[B]obase\f[R], which must be between \f[B]0\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and +the \f[B]NUMBERS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]j\f[] +\f[B]j\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]seed\f[]. -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +\f[B]seed\f[R]. +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP -The \f[I]scale\f[] and sign of the value may be significant. +The \f[I]scale\f[R] and sign of the value may be significant. .PP -If a previously used \f[B]seed\f[] value is used again, the -pseudo\-random number generator is guaranteed to produce the same -sequence of pseudo\-random numbers as it did when the \f[B]seed\f[] +If a previously used \f[B]seed\f[R] value is used again, the +pseudo-random number generator is guaranteed to produce the same +sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if the \f[B]J\f[] command is used. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will not -produce unique sequences of pseudo\-random numbers. +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if the \f[B]J\f[R] command is used. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will not +produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]J\f[] -Pushes the current value of \f[B]seed\f[] onto the main stack. +\f[B]J\f[R] +Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]W\f[] +\f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the -\f[B]\[aq]\f[] pseudo\-random number generator command. +\f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -796,18 +768,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -815,26 +787,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -846,160 +818,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -1009,37 +975,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -1047,31 +1007,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1084,303 +1044,270 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]\[aq]\f[] command, +\f[B]DC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). -Set at \f[B]2^DC_LONG_BIT\-1\f[]. -.RS -.RE +Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]H\f[]), and -right shift (\f[B]h\f[]) operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP The prompt is enabled in TTY mode. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGS\f[]. +locales and thus, supports \f[B]LC_MESSAGS\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1389,4 +1316,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/H.1.md b/contrib/bc/manuals/dc/H.1.md index 327e27a0c893..6542f63d4fdc 100644 --- a/contrib/bc/manuals/dc/H.1.md +++ b/contrib/bc/manuals/dc/H.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -222,9 +222,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **15**. In addition, dc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still @@ -339,7 +339,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1176,6 +1177,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/HN.1 b/contrib/bc/manuals/dc/HN.1 index 8b032e82f1f9..2c8bde98b88a 100644 --- a/contrib/bc/manuals/dc/HN.1 +++ b/contrib/bc/manuals/dc/HN.1 @@ -25,92 +25,90 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in -\f[B]DC_ENV_ARGS\f[]. +\f[B]DC_ENV_ARGS\f[R]. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -119,165 +117,167 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. -.PP -\f[B]seed\f[] is a register containing the current seed for the -pseudo\-random number generator. -If the current value of \f[B]seed\f[] is queried and stored, then if it -is assigned to \f[B]seed\f[] later, the pseudo\-random number generator -is guaranteed to produce the same sequence of pseudo\-random numbers -that were generated after the value of \f[B]seed\f[] was first queried. -.PP -Multiple values assigned to \f[B]seed\f[] can produce the same sequence -of pseudo\-random numbers. -Likewise, when a value is assigned to \f[B]seed\f[], it is not -guaranteed that querying \f[B]seed\f[] immediately after will return the -same value. -In addition, the value of \f[B]seed\f[] will change after any call to -the \f[B]\[aq]\f[] command or the \f[B]"\f[] command that does not get -receive a value of \f[B]0\f[] or \f[B]1\f[]. -The maximum integer returned by the \f[B]\[aq]\f[] command can be -queried with the \f[B]W\f[] command. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with the \f[B]\[aq]\f[] and \f[B]"\f[] commands are guaranteed -to \f[B]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[B]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. -.PP -The pseudo\-random number generator, \f[B]seed\f[], and all associated -operations are \f[B]non\-portable extensions\f[]. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. +.PP +\f[B]seed\f[R] is a register containing the current seed for the +pseudo-random number generator. +If the current value of \f[B]seed\f[R] is queried and stored, then if it +is assigned to \f[B]seed\f[R] later, the pseudo-random number generator +is guaranteed to produce the same sequence of pseudo-random numbers that +were generated after the value of \f[B]seed\f[R] was first queried. +.PP +Multiple values assigned to \f[B]seed\f[R] can produce the same sequence +of pseudo-random numbers. +Likewise, when a value is assigned to \f[B]seed\f[R], it is not +guaranteed that querying \f[B]seed\f[R] immediately after will return +the same value. +In addition, the value of \f[B]seed\f[R] will change after any call to +the \f[B]\[cq]\f[R] command or the \f[B]\[dq]\f[R] command that does not +get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. +The maximum integer returned by the \f[B]\[cq]\f[R] command can be +queried with the \f[B]W\f[R] command. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with the \f[B]\[cq]\f[R] and \f[B]\[dq]\f[R] commands are +guaranteed to \f[B]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[B]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. +.PP +The pseudo-random number generator, \f[B]seed\f[R], and all associated +operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e_3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and dc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if dc(1) is given the number string -\f[B]10e_4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if dc(1) is given the number string +\f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -287,15 +287,16 @@ These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[] using \f[B]0o\f[], and engineering notation is activated -by assigning \f[B]1\f[] to \f[B]obase\f[] using \f[B]1o\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is +activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using +\f[B]1o\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -303,27 +304,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -334,461 +333,434 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]H\f[] +\f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]h\f[] +\f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE -.SS Pseudo\-Random Number Generator +.SS Pseudo-Random Number Generator .PP -dc(1) has a built\-in pseudo\-random number generator. -These commands query the pseudo\-random number generator. -(See Parameters for more information about the \f[B]seed\f[] value that -controls the pseudo\-random number generator.) +dc(1) has a built-in pseudo-random number generator. +These commands query the pseudo-random number generator. +(See Parameters for more information about the \f[B]seed\f[R] value that +controls the pseudo-random number generator.) .PP -The pseudo\-random number generator is guaranteed to \f[B]NOT\f[] be +The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP -.B \f[B]\[aq]\f[] -Generates an integer between 0 and \f[B]DC_RAND_MAX\f[], inclusive (see -the \f[B]LIMITS\f[] section). +\f[B]\[cq]\f[R] +Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see +the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]"\f[] -Pops a value off of the stack, which is used as an \f[B]exclusive\f[] +\f[B]\[dq]\f[R] +Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. -If the bound is negative or is a non\-integer, an error is raised, and -dc(1) resets (see the \f[B]RESET\f[] section) while \f[B]seed\f[] +If the bound is negative or is a non-integer, an error is raised, and +dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. -If the bound is larger than \f[B]DC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]DC_RAND_MAX+1\f[], and adding them +If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. -Using this command will change the value of \f[B]seed\f[], unless the -operand is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is pushed onto the stack, and \f[B]seed\f[] is -\f[I]not\f[] changed. +Using this command will change the value of \f[B]seed\f[R], unless the +operand is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] +is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], -\f[B]scale\f[], and \f[B]seed\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +\f[B]scale\f[R], and \f[B]seed\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]0\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section and the -\f[B]NUMBERS\f[] section). +\f[B]obase\f[R], which must be between \f[B]0\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and +the \f[B]NUMBERS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]j\f[] +\f[B]j\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]seed\f[]. -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +\f[B]seed\f[R]. +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP -The \f[I]scale\f[] and sign of the value may be significant. +The \f[I]scale\f[R] and sign of the value may be significant. .PP -If a previously used \f[B]seed\f[] value is used again, the -pseudo\-random number generator is guaranteed to produce the same -sequence of pseudo\-random numbers as it did when the \f[B]seed\f[] +If a previously used \f[B]seed\f[R] value is used again, the +pseudo-random number generator is guaranteed to produce the same +sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if the \f[B]J\f[] command is used. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will not -produce unique sequences of pseudo\-random numbers. +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if the \f[B]J\f[R] command is used. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will not +produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]J\f[] -Pushes the current value of \f[B]seed\f[] onto the main stack. +\f[B]J\f[R] +Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]W\f[] +\f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the -\f[B]\[aq]\f[] pseudo\-random number generator command. +\f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -796,18 +768,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -815,26 +787,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -846,160 +818,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -1009,37 +975,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -1047,31 +1007,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1084,299 +1044,266 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]\[aq]\f[] command, +\f[B]DC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). -Set at \f[B]2^DC_LONG_BIT\-1\f[]. -.RS -.RE +Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]H\f[]), and -right shift (\f[B]h\f[]) operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP The prompt is enabled in TTY mode. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1385,4 +1312,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/HN.1.md b/contrib/bc/manuals/dc/HN.1.md index f128840138a5..b81a98ffbf4f 100644 --- a/contrib/bc/manuals/dc/HN.1.md +++ b/contrib/bc/manuals/dc/HN.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -222,9 +222,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **15**. In addition, dc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still @@ -339,7 +339,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1171,6 +1172,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/HNP.1 b/contrib/bc/manuals/dc/HNP.1 index f5152fa781d4..a777eaa81074 100644 --- a/contrib/bc/manuals/dc/HNP.1 +++ b/contrib/bc/manuals/dc/HNP.1 @@ -25,87 +25,85 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -114,165 +112,167 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. -.PP -\f[B]seed\f[] is a register containing the current seed for the -pseudo\-random number generator. -If the current value of \f[B]seed\f[] is queried and stored, then if it -is assigned to \f[B]seed\f[] later, the pseudo\-random number generator -is guaranteed to produce the same sequence of pseudo\-random numbers -that were generated after the value of \f[B]seed\f[] was first queried. -.PP -Multiple values assigned to \f[B]seed\f[] can produce the same sequence -of pseudo\-random numbers. -Likewise, when a value is assigned to \f[B]seed\f[], it is not -guaranteed that querying \f[B]seed\f[] immediately after will return the -same value. -In addition, the value of \f[B]seed\f[] will change after any call to -the \f[B]\[aq]\f[] command or the \f[B]"\f[] command that does not get -receive a value of \f[B]0\f[] or \f[B]1\f[]. -The maximum integer returned by the \f[B]\[aq]\f[] command can be -queried with the \f[B]W\f[] command. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with the \f[B]\[aq]\f[] and \f[B]"\f[] commands are guaranteed -to \f[B]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[B]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. -.PP -The pseudo\-random number generator, \f[B]seed\f[], and all associated -operations are \f[B]non\-portable extensions\f[]. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. +.PP +\f[B]seed\f[R] is a register containing the current seed for the +pseudo-random number generator. +If the current value of \f[B]seed\f[R] is queried and stored, then if it +is assigned to \f[B]seed\f[R] later, the pseudo-random number generator +is guaranteed to produce the same sequence of pseudo-random numbers that +were generated after the value of \f[B]seed\f[R] was first queried. +.PP +Multiple values assigned to \f[B]seed\f[R] can produce the same sequence +of pseudo-random numbers. +Likewise, when a value is assigned to \f[B]seed\f[R], it is not +guaranteed that querying \f[B]seed\f[R] immediately after will return +the same value. +In addition, the value of \f[B]seed\f[R] will change after any call to +the \f[B]\[cq]\f[R] command or the \f[B]\[dq]\f[R] command that does not +get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. +The maximum integer returned by the \f[B]\[cq]\f[R] command can be +queried with the \f[B]W\f[R] command. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with the \f[B]\[cq]\f[R] and \f[B]\[dq]\f[R] commands are +guaranteed to \f[B]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[B]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. +.PP +The pseudo-random number generator, \f[B]seed\f[R], and all associated +operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e_3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and dc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if dc(1) is given the number string -\f[B]10e_4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if dc(1) is given the number string +\f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -282,15 +282,16 @@ These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[] using \f[B]0o\f[], and engineering notation is activated -by assigning \f[B]1\f[] to \f[B]obase\f[] using \f[B]1o\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is +activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using +\f[B]1o\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -298,27 +299,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -329,461 +328,434 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]H\f[] +\f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]h\f[] +\f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE -.SS Pseudo\-Random Number Generator +.SS Pseudo-Random Number Generator .PP -dc(1) has a built\-in pseudo\-random number generator. -These commands query the pseudo\-random number generator. -(See Parameters for more information about the \f[B]seed\f[] value that -controls the pseudo\-random number generator.) +dc(1) has a built-in pseudo-random number generator. +These commands query the pseudo-random number generator. +(See Parameters for more information about the \f[B]seed\f[R] value that +controls the pseudo-random number generator.) .PP -The pseudo\-random number generator is guaranteed to \f[B]NOT\f[] be +The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP -.B \f[B]\[aq]\f[] -Generates an integer between 0 and \f[B]DC_RAND_MAX\f[], inclusive (see -the \f[B]LIMITS\f[] section). +\f[B]\[cq]\f[R] +Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see +the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]"\f[] -Pops a value off of the stack, which is used as an \f[B]exclusive\f[] +\f[B]\[dq]\f[R] +Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. -If the bound is negative or is a non\-integer, an error is raised, and -dc(1) resets (see the \f[B]RESET\f[] section) while \f[B]seed\f[] +If the bound is negative or is a non-integer, an error is raised, and +dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. -If the bound is larger than \f[B]DC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]DC_RAND_MAX+1\f[], and adding them +If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. -Using this command will change the value of \f[B]seed\f[], unless the -operand is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is pushed onto the stack, and \f[B]seed\f[] is -\f[I]not\f[] changed. +Using this command will change the value of \f[B]seed\f[R], unless the +operand is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] +is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], -\f[B]scale\f[], and \f[B]seed\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +\f[B]scale\f[R], and \f[B]seed\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]0\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section and the -\f[B]NUMBERS\f[] section). +\f[B]obase\f[R], which must be between \f[B]0\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and +the \f[B]NUMBERS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]j\f[] +\f[B]j\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]seed\f[]. -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +\f[B]seed\f[R]. +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP -The \f[I]scale\f[] and sign of the value may be significant. +The \f[I]scale\f[R] and sign of the value may be significant. .PP -If a previously used \f[B]seed\f[] value is used again, the -pseudo\-random number generator is guaranteed to produce the same -sequence of pseudo\-random numbers as it did when the \f[B]seed\f[] +If a previously used \f[B]seed\f[R] value is used again, the +pseudo-random number generator is guaranteed to produce the same +sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if the \f[B]J\f[] command is used. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will not -produce unique sequences of pseudo\-random numbers. +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if the \f[B]J\f[R] command is used. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will not +produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]J\f[] -Pushes the current value of \f[B]seed\f[] onto the main stack. +\f[B]J\f[R] +Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]W\f[] +\f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the -\f[B]\[aq]\f[] pseudo\-random number generator command. +\f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -791,18 +763,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -810,26 +782,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -841,160 +813,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -1004,37 +970,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -1042,31 +1002,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1079,297 +1039,264 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]\[aq]\f[] command, +\f[B]DC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). -Set at \f[B]2^DC_LONG_BIT\-1\f[]. -.RS -.RE +Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]H\f[]), and -right shift (\f[B]h\f[]) operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1378,4 +1305,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/HNP.1.md b/contrib/bc/manuals/dc/HNP.1.md index fc71488f8b53..c4431fd7a4b2 100644 --- a/contrib/bc/manuals/dc/HNP.1.md +++ b/contrib/bc/manuals/dc/HNP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -219,9 +219,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **15**. In addition, dc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still @@ -336,7 +336,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1166,6 +1167,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/HP.1 b/contrib/bc/manuals/dc/HP.1 index eeae02949fc0..872e6ef3e40b 100644 --- a/contrib/bc/manuals/dc/HP.1 +++ b/contrib/bc/manuals/dc/HP.1 @@ -25,87 +25,85 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -114,165 +112,167 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. -.PP -\f[B]seed\f[] is a register containing the current seed for the -pseudo\-random number generator. -If the current value of \f[B]seed\f[] is queried and stored, then if it -is assigned to \f[B]seed\f[] later, the pseudo\-random number generator -is guaranteed to produce the same sequence of pseudo\-random numbers -that were generated after the value of \f[B]seed\f[] was first queried. -.PP -Multiple values assigned to \f[B]seed\f[] can produce the same sequence -of pseudo\-random numbers. -Likewise, when a value is assigned to \f[B]seed\f[], it is not -guaranteed that querying \f[B]seed\f[] immediately after will return the -same value. -In addition, the value of \f[B]seed\f[] will change after any call to -the \f[B]\[aq]\f[] command or the \f[B]"\f[] command that does not get -receive a value of \f[B]0\f[] or \f[B]1\f[]. -The maximum integer returned by the \f[B]\[aq]\f[] command can be -queried with the \f[B]W\f[] command. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with the \f[B]\[aq]\f[] and \f[B]"\f[] commands are guaranteed -to \f[B]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[B]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. -.PP -The pseudo\-random number generator, \f[B]seed\f[], and all associated -operations are \f[B]non\-portable extensions\f[]. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. +.PP +\f[B]seed\f[R] is a register containing the current seed for the +pseudo-random number generator. +If the current value of \f[B]seed\f[R] is queried and stored, then if it +is assigned to \f[B]seed\f[R] later, the pseudo-random number generator +is guaranteed to produce the same sequence of pseudo-random numbers that +were generated after the value of \f[B]seed\f[R] was first queried. +.PP +Multiple values assigned to \f[B]seed\f[R] can produce the same sequence +of pseudo-random numbers. +Likewise, when a value is assigned to \f[B]seed\f[R], it is not +guaranteed that querying \f[B]seed\f[R] immediately after will return +the same value. +In addition, the value of \f[B]seed\f[R] will change after any call to +the \f[B]\[cq]\f[R] command or the \f[B]\[dq]\f[R] command that does not +get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. +The maximum integer returned by the \f[B]\[cq]\f[R] command can be +queried with the \f[B]W\f[R] command. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with the \f[B]\[cq]\f[R] and \f[B]\[dq]\f[R] commands are +guaranteed to \f[B]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[B]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. +.PP +The pseudo-random number generator, \f[B]seed\f[R], and all associated +operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e_3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and dc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if dc(1) is given the number string -\f[B]10e_4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if dc(1) is given the number string +\f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -282,15 +282,16 @@ These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[] using \f[B]0o\f[], and engineering notation is activated -by assigning \f[B]1\f[] to \f[B]obase\f[] using \f[B]1o\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is +activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using +\f[B]1o\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -298,27 +299,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -329,461 +328,434 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]H\f[] +\f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]h\f[] +\f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE -.SS Pseudo\-Random Number Generator +.SS Pseudo-Random Number Generator .PP -dc(1) has a built\-in pseudo\-random number generator. -These commands query the pseudo\-random number generator. -(See Parameters for more information about the \f[B]seed\f[] value that -controls the pseudo\-random number generator.) +dc(1) has a built-in pseudo-random number generator. +These commands query the pseudo-random number generator. +(See Parameters for more information about the \f[B]seed\f[R] value that +controls the pseudo-random number generator.) .PP -The pseudo\-random number generator is guaranteed to \f[B]NOT\f[] be +The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP -.B \f[B]\[aq]\f[] -Generates an integer between 0 and \f[B]DC_RAND_MAX\f[], inclusive (see -the \f[B]LIMITS\f[] section). +\f[B]\[cq]\f[R] +Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see +the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]"\f[] -Pops a value off of the stack, which is used as an \f[B]exclusive\f[] +\f[B]\[dq]\f[R] +Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. -If the bound is negative or is a non\-integer, an error is raised, and -dc(1) resets (see the \f[B]RESET\f[] section) while \f[B]seed\f[] +If the bound is negative or is a non-integer, an error is raised, and +dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. -If the bound is larger than \f[B]DC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]DC_RAND_MAX+1\f[], and adding them +If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. -Using this command will change the value of \f[B]seed\f[], unless the -operand is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is pushed onto the stack, and \f[B]seed\f[] is -\f[I]not\f[] changed. +Using this command will change the value of \f[B]seed\f[R], unless the +operand is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] +is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], -\f[B]scale\f[], and \f[B]seed\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +\f[B]scale\f[R], and \f[B]seed\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]0\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section and the -\f[B]NUMBERS\f[] section). +\f[B]obase\f[R], which must be between \f[B]0\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and +the \f[B]NUMBERS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]j\f[] +\f[B]j\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]seed\f[]. -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +\f[B]seed\f[R]. +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP -The \f[I]scale\f[] and sign of the value may be significant. +The \f[I]scale\f[R] and sign of the value may be significant. .PP -If a previously used \f[B]seed\f[] value is used again, the -pseudo\-random number generator is guaranteed to produce the same -sequence of pseudo\-random numbers as it did when the \f[B]seed\f[] +If a previously used \f[B]seed\f[R] value is used again, the +pseudo-random number generator is guaranteed to produce the same +sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if the \f[B]J\f[] command is used. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will not -produce unique sequences of pseudo\-random numbers. +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if the \f[B]J\f[R] command is used. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will not +produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]J\f[] -Pushes the current value of \f[B]seed\f[] onto the main stack. +\f[B]J\f[R] +Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]W\f[] +\f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the -\f[B]\[aq]\f[] pseudo\-random number generator command. +\f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -791,18 +763,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -810,26 +782,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -841,160 +813,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -1004,37 +970,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -1042,31 +1002,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1079,301 +1039,268 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]\[aq]\f[] command, +\f[B]DC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). -Set at \f[B]2^DC_LONG_BIT\-1\f[]. -.RS -.RE +Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]H\f[]), and -right shift (\f[B]h\f[]) operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGS\f[]. +locales and thus, supports \f[B]LC_MESSAGS\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1382,4 +1309,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/HP.1.md b/contrib/bc/manuals/dc/HP.1.md index 88e0914d6266..ffc61e93247b 100644 --- a/contrib/bc/manuals/dc/HP.1.md +++ b/contrib/bc/manuals/dc/HP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -219,9 +219,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **15**. In addition, dc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still @@ -336,7 +336,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1171,6 +1172,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/N.1 b/contrib/bc/manuals/dc/N.1 index a7ca5b5fec27..590d563faa50 100644 --- a/contrib/bc/manuals/dc/N.1 +++ b/contrib/bc/manuals/dc/N.1 @@ -25,92 +25,90 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] Disables the prompt in TTY mode. (The prompt is only enabled in TTY mode. -See the \f[B]TTY MODE\f[] section) This is mostly for those users that +See the \f[B]TTY MODE\f[R] section) This is mostly for those users that do not want a prompt or are not used to having them in dc(1). Most of those users would want to put this option in -\f[B]DC_ENV_ARGS\f[]. +\f[B]DC_ENV_ARGS\f[R]. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -119,165 +117,167 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. -.PP -\f[B]seed\f[] is a register containing the current seed for the -pseudo\-random number generator. -If the current value of \f[B]seed\f[] is queried and stored, then if it -is assigned to \f[B]seed\f[] later, the pseudo\-random number generator -is guaranteed to produce the same sequence of pseudo\-random numbers -that were generated after the value of \f[B]seed\f[] was first queried. -.PP -Multiple values assigned to \f[B]seed\f[] can produce the same sequence -of pseudo\-random numbers. -Likewise, when a value is assigned to \f[B]seed\f[], it is not -guaranteed that querying \f[B]seed\f[] immediately after will return the -same value. -In addition, the value of \f[B]seed\f[] will change after any call to -the \f[B]\[aq]\f[] command or the \f[B]"\f[] command that does not get -receive a value of \f[B]0\f[] or \f[B]1\f[]. -The maximum integer returned by the \f[B]\[aq]\f[] command can be -queried with the \f[B]W\f[] command. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with the \f[B]\[aq]\f[] and \f[B]"\f[] commands are guaranteed -to \f[B]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[B]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. -.PP -The pseudo\-random number generator, \f[B]seed\f[], and all associated -operations are \f[B]non\-portable extensions\f[]. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. +.PP +\f[B]seed\f[R] is a register containing the current seed for the +pseudo-random number generator. +If the current value of \f[B]seed\f[R] is queried and stored, then if it +is assigned to \f[B]seed\f[R] later, the pseudo-random number generator +is guaranteed to produce the same sequence of pseudo-random numbers that +were generated after the value of \f[B]seed\f[R] was first queried. +.PP +Multiple values assigned to \f[B]seed\f[R] can produce the same sequence +of pseudo-random numbers. +Likewise, when a value is assigned to \f[B]seed\f[R], it is not +guaranteed that querying \f[B]seed\f[R] immediately after will return +the same value. +In addition, the value of \f[B]seed\f[R] will change after any call to +the \f[B]\[cq]\f[R] command or the \f[B]\[dq]\f[R] command that does not +get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. +The maximum integer returned by the \f[B]\[cq]\f[R] command can be +queried with the \f[B]W\f[R] command. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with the \f[B]\[cq]\f[R] and \f[B]\[dq]\f[R] commands are +guaranteed to \f[B]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[B]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. +.PP +The pseudo-random number generator, \f[B]seed\f[R], and all associated +operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e_3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and dc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if dc(1) is given the number string -\f[B]10e_4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if dc(1) is given the number string +\f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -287,15 +287,16 @@ These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[] using \f[B]0o\f[], and engineering notation is activated -by assigning \f[B]1\f[] to \f[B]obase\f[] using \f[B]1o\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is +activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using +\f[B]1o\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -303,27 +304,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -334,461 +333,434 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]H\f[] +\f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]h\f[] +\f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE -.SS Pseudo\-Random Number Generator +.SS Pseudo-Random Number Generator .PP -dc(1) has a built\-in pseudo\-random number generator. -These commands query the pseudo\-random number generator. -(See Parameters for more information about the \f[B]seed\f[] value that -controls the pseudo\-random number generator.) +dc(1) has a built-in pseudo-random number generator. +These commands query the pseudo-random number generator. +(See Parameters for more information about the \f[B]seed\f[R] value that +controls the pseudo-random number generator.) .PP -The pseudo\-random number generator is guaranteed to \f[B]NOT\f[] be +The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP -.B \f[B]\[aq]\f[] -Generates an integer between 0 and \f[B]DC_RAND_MAX\f[], inclusive (see -the \f[B]LIMITS\f[] section). +\f[B]\[cq]\f[R] +Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see +the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]"\f[] -Pops a value off of the stack, which is used as an \f[B]exclusive\f[] +\f[B]\[dq]\f[R] +Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. -If the bound is negative or is a non\-integer, an error is raised, and -dc(1) resets (see the \f[B]RESET\f[] section) while \f[B]seed\f[] +If the bound is negative or is a non-integer, an error is raised, and +dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. -If the bound is larger than \f[B]DC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]DC_RAND_MAX+1\f[], and adding them +If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. -Using this command will change the value of \f[B]seed\f[], unless the -operand is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is pushed onto the stack, and \f[B]seed\f[] is -\f[I]not\f[] changed. +Using this command will change the value of \f[B]seed\f[R], unless the +operand is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] +is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], -\f[B]scale\f[], and \f[B]seed\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +\f[B]scale\f[R], and \f[B]seed\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]0\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section and the -\f[B]NUMBERS\f[] section). +\f[B]obase\f[R], which must be between \f[B]0\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and +the \f[B]NUMBERS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]j\f[] +\f[B]j\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]seed\f[]. -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +\f[B]seed\f[R]. +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP -The \f[I]scale\f[] and sign of the value may be significant. +The \f[I]scale\f[R] and sign of the value may be significant. .PP -If a previously used \f[B]seed\f[] value is used again, the -pseudo\-random number generator is guaranteed to produce the same -sequence of pseudo\-random numbers as it did when the \f[B]seed\f[] +If a previously used \f[B]seed\f[R] value is used again, the +pseudo-random number generator is guaranteed to produce the same +sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if the \f[B]J\f[] command is used. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will not -produce unique sequences of pseudo\-random numbers. +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if the \f[B]J\f[R] command is used. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will not +produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]J\f[] -Pushes the current value of \f[B]seed\f[] onto the main stack. +\f[B]J\f[R] +Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]W\f[] +\f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the -\f[B]\[aq]\f[] pseudo\-random number generator command. +\f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -796,18 +768,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -815,26 +787,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -846,160 +818,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -1009,37 +975,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -1047,31 +1007,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1084,261 +1044,228 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]\[aq]\f[] command, +\f[B]DC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). -Set at \f[B]2^DC_LONG_BIT\-1\f[]. -.RS -.RE +Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]H\f[]), and -right shift (\f[B]h\f[]) operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP The prompt is enabled in TTY mode. @@ -1346,52 +1273,52 @@ The prompt is enabled in TTY mode. TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when dc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause dc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when dc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -dc(1) supports interactive command\-line editing. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +dc(1) supports interactive command-line editing. +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1400,4 +1327,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/N.1.md b/contrib/bc/manuals/dc/N.1.md index 6e843649b37d..ef94824c7a00 100644 --- a/contrib/bc/manuals/dc/N.1.md +++ b/contrib/bc/manuals/dc/N.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -222,9 +222,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **15**. In addition, dc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still @@ -339,7 +339,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1184,6 +1185,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/NP.1 b/contrib/bc/manuals/dc/NP.1 index bfd1c0e59d4f..01c5f1e854f2 100644 --- a/contrib/bc/manuals/dc/NP.1 +++ b/contrib/bc/manuals/dc/NP.1 @@ -25,87 +25,85 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -114,165 +112,167 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. -.PP -\f[B]seed\f[] is a register containing the current seed for the -pseudo\-random number generator. -If the current value of \f[B]seed\f[] is queried and stored, then if it -is assigned to \f[B]seed\f[] later, the pseudo\-random number generator -is guaranteed to produce the same sequence of pseudo\-random numbers -that were generated after the value of \f[B]seed\f[] was first queried. -.PP -Multiple values assigned to \f[B]seed\f[] can produce the same sequence -of pseudo\-random numbers. -Likewise, when a value is assigned to \f[B]seed\f[], it is not -guaranteed that querying \f[B]seed\f[] immediately after will return the -same value. -In addition, the value of \f[B]seed\f[] will change after any call to -the \f[B]\[aq]\f[] command or the \f[B]"\f[] command that does not get -receive a value of \f[B]0\f[] or \f[B]1\f[]. -The maximum integer returned by the \f[B]\[aq]\f[] command can be -queried with the \f[B]W\f[] command. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with the \f[B]\[aq]\f[] and \f[B]"\f[] commands are guaranteed -to \f[B]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[B]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. -.PP -The pseudo\-random number generator, \f[B]seed\f[], and all associated -operations are \f[B]non\-portable extensions\f[]. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. +.PP +\f[B]seed\f[R] is a register containing the current seed for the +pseudo-random number generator. +If the current value of \f[B]seed\f[R] is queried and stored, then if it +is assigned to \f[B]seed\f[R] later, the pseudo-random number generator +is guaranteed to produce the same sequence of pseudo-random numbers that +were generated after the value of \f[B]seed\f[R] was first queried. +.PP +Multiple values assigned to \f[B]seed\f[R] can produce the same sequence +of pseudo-random numbers. +Likewise, when a value is assigned to \f[B]seed\f[R], it is not +guaranteed that querying \f[B]seed\f[R] immediately after will return +the same value. +In addition, the value of \f[B]seed\f[R] will change after any call to +the \f[B]\[cq]\f[R] command or the \f[B]\[dq]\f[R] command that does not +get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. +The maximum integer returned by the \f[B]\[cq]\f[R] command can be +queried with the \f[B]W\f[R] command. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with the \f[B]\[cq]\f[R] and \f[B]\[dq]\f[R] commands are +guaranteed to \f[B]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[B]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. +.PP +The pseudo-random number generator, \f[B]seed\f[R], and all associated +operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e_3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and dc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if dc(1) is given the number string -\f[B]10e_4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if dc(1) is given the number string +\f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -282,15 +282,16 @@ These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[] using \f[B]0o\f[], and engineering notation is activated -by assigning \f[B]1\f[] to \f[B]obase\f[] using \f[B]1o\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is +activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using +\f[B]1o\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -298,27 +299,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -329,461 +328,434 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]H\f[] +\f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]h\f[] +\f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE -.SS Pseudo\-Random Number Generator +.SS Pseudo-Random Number Generator .PP -dc(1) has a built\-in pseudo\-random number generator. -These commands query the pseudo\-random number generator. -(See Parameters for more information about the \f[B]seed\f[] value that -controls the pseudo\-random number generator.) +dc(1) has a built-in pseudo-random number generator. +These commands query the pseudo-random number generator. +(See Parameters for more information about the \f[B]seed\f[R] value that +controls the pseudo-random number generator.) .PP -The pseudo\-random number generator is guaranteed to \f[B]NOT\f[] be +The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP -.B \f[B]\[aq]\f[] -Generates an integer between 0 and \f[B]DC_RAND_MAX\f[], inclusive (see -the \f[B]LIMITS\f[] section). +\f[B]\[cq]\f[R] +Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see +the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]"\f[] -Pops a value off of the stack, which is used as an \f[B]exclusive\f[] +\f[B]\[dq]\f[R] +Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. -If the bound is negative or is a non\-integer, an error is raised, and -dc(1) resets (see the \f[B]RESET\f[] section) while \f[B]seed\f[] +If the bound is negative or is a non-integer, an error is raised, and +dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. -If the bound is larger than \f[B]DC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]DC_RAND_MAX+1\f[], and adding them +If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. -Using this command will change the value of \f[B]seed\f[], unless the -operand is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is pushed onto the stack, and \f[B]seed\f[] is -\f[I]not\f[] changed. +Using this command will change the value of \f[B]seed\f[R], unless the +operand is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] +is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], -\f[B]scale\f[], and \f[B]seed\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +\f[B]scale\f[R], and \f[B]seed\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]0\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section and the -\f[B]NUMBERS\f[] section). +\f[B]obase\f[R], which must be between \f[B]0\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and +the \f[B]NUMBERS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]j\f[] +\f[B]j\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]seed\f[]. -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +\f[B]seed\f[R]. +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP -The \f[I]scale\f[] and sign of the value may be significant. +The \f[I]scale\f[R] and sign of the value may be significant. .PP -If a previously used \f[B]seed\f[] value is used again, the -pseudo\-random number generator is guaranteed to produce the same -sequence of pseudo\-random numbers as it did when the \f[B]seed\f[] +If a previously used \f[B]seed\f[R] value is used again, the +pseudo-random number generator is guaranteed to produce the same +sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if the \f[B]J\f[] command is used. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will not -produce unique sequences of pseudo\-random numbers. +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if the \f[B]J\f[R] command is used. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will not +produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]J\f[] -Pushes the current value of \f[B]seed\f[] onto the main stack. +\f[B]J\f[R] +Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]W\f[] +\f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the -\f[B]\[aq]\f[] pseudo\-random number generator command. +\f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -791,18 +763,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -810,26 +782,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -841,160 +813,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -1004,37 +970,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -1042,31 +1002,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1079,312 +1039,279 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]\[aq]\f[] command, +\f[B]DC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). -Set at \f[B]2^DC_LONG_BIT\-1\f[]. -.RS -.RE +Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]H\f[]), and -right shift (\f[B]h\f[]) operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when dc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause dc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when dc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -dc(1) supports interactive command\-line editing. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +dc(1) supports interactive command-line editing. +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1393,4 +1320,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/NP.1.md b/contrib/bc/manuals/dc/NP.1.md index b83d20a806bb..e744a40c2474 100644 --- a/contrib/bc/manuals/dc/NP.1.md +++ b/contrib/bc/manuals/dc/NP.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -219,9 +219,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **15**. In addition, dc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still @@ -336,7 +336,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1179,6 +1180,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/dc/P.1 b/contrib/bc/manuals/dc/P.1 index 6f5cd4cec1d3..a39132aea914 100644 --- a/contrib/bc/manuals/dc/P.1 +++ b/contrib/bc/manuals/dc/P.1 @@ -25,87 +25,85 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.TH "DC" "1" "July 2020" "Gavin D. Howard" "General Commands Manual" +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" .SH Name .PP -dc \- arbitrary\-precision reverse\-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator .SH SYNOPSIS .PP -\f[B]dc\f[] [\f[B]\-hiPvVx\f[]] [\f[B]\-\-version\f[]] -[\f[B]\-\-help\f[]] [\f[B]\-\-interactive\f[]] [\f[B]\-\-no\-prompt\f[]] -[\f[B]\-\-extended\-register\f[]] [\f[B]\-e\f[] \f[I]expr\f[]] -[\f[B]\-\-expression\f[]=\f[I]expr\f[]...] [\f[B]\-f\f[] -\f[I]file\f[]...] [\f[B]\-file\f[]=\f[I]file\f[]...] [\f[I]file\f[]...] +\f[B]dc\f[R] [\f[B]-hiPvVx\f[R]] [\f[B]\[en]version\f[R]] +[\f[B]\[en]help\f[R]] [\f[B]\[en]interactive\f[R]] +[\f[B]\[en]no-prompt\f[R]] [\f[B]\[en]extended-register\f[R]] +[\f[B]-e\f[R] \f[I]expr\f[R]] +[\f[B]\[en]expression\f[R]=\f[I]expr\f[R]\&...] [\f[B]-f\f[R] +\f[I]file\f[R]\&...] [\f[B]-file\f[R]=\f[I]file\f[R]\&...] +[\f[I]file\f[R]\&...] .SH DESCRIPTION .PP -dc(1) is an arbitrary\-precision calculator. +dc(1) is an arbitrary-precision calculator. It uses a stack (reverse Polish notation) to store numbers and results of computations. Arithmetic operations pop arguments off of the stack and push the results. .PP -If no files are given on the command\-line as extra arguments (i.e., not -as \f[B]\-f\f[] or \f[B]\-\-file\f[] arguments), then dc(1) reads from -\f[B]stdin\f[]. +If no files are given on the command-line as extra arguments (i.e., not +as \f[B]-f\f[R] or \f[B]\[en]file\f[R] arguments), then dc(1) reads from +\f[B]stdin\f[R]. Otherwise, those files are processed, and dc(1) will then exit. .PP This is different from the dc(1) on OpenBSD and possibly other dc(1) -implementations, where \f[B]\-e\f[] (\f[B]\-\-expression\f[]) and -\f[B]\-f\f[] (\f[B]\-\-file\f[]) arguments cause dc(1) to execute them +implementations, where \f[B]-e\f[R] (\f[B]\[en]expression\f[R]) and +\f[B]-f\f[R] (\f[B]\[en]file\f[R]) arguments cause dc(1) to execute them and exit. The reason for this is that this dc(1) allows users to set arguments in -the environment variable \f[B]DC_ENV_ARGS\f[] (see the \f[B]ENVIRONMENT -VARIABLES\f[] section). -Any expressions given on the command\-line should be used to set up a +the environment variable \f[B]DC_ENV_ARGS\f[R] (see the \f[B]ENVIRONMENT +VARIABLES\f[R] section). +Any expressions given on the command-line should be used to set up a standard environment. -For example, if a user wants the \f[B]scale\f[] always set to -\f[B]10\f[], they can set \f[B]DC_ENV_ARGS\f[] to \f[B]\-e 10k\f[], and -this dc(1) will always start with a \f[B]scale\f[] of \f[B]10\f[]. +For example, if a user wants the \f[B]scale\f[R] always set to +\f[B]10\f[R], they can set \f[B]DC_ENV_ARGS\f[R] to \f[B]-e 10k\f[R], +and this dc(1) will always start with a \f[B]scale\f[R] of \f[B]10\f[R]. .PP If users want to have dc(1) exit after processing all input from -\f[B]\-e\f[] and \f[B]\-f\f[] arguments (and their equivalents), then -they can just simply add \f[B]\-e q\f[] as the last command\-line -argument or define the environment variable \f[B]DC_EXPR_EXIT\f[]. +\f[B]-e\f[R] and \f[B]-f\f[R] arguments (and their equivalents), then +they can just simply add \f[B]-e q\f[R] as the last command-line +argument or define the environment variable \f[B]DC_EXPR_EXIT\f[R]. .SH OPTIONS .PP The following are the options that dc(1) accepts. .TP -.B \f[B]\-h\f[], \f[B]\-\-help\f[] +\f[B]-h\f[R], \f[B]\[en]help\f[R] Prints a usage message and quits. -.RS -.RE .TP -.B \f[B]\-v\f[], \f[B]\-V\f[], \f[B]\-\-version\f[] +\f[B]-v\f[R], \f[B]-V\f[R], \f[B]\[en]version\f[R] Print the version information (copyright header) and exit. -.RS -.RE .TP -.B \f[B]\-i\f[], \f[B]\-\-interactive\f[] +\f[B]-i\f[R], \f[B]\[en]interactive\f[R] Forces interactive mode. -(See the \f[B]INTERACTIVE MODE\f[] section.) +(See the \f[B]INTERACTIVE MODE\f[R] section.) .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-P\f[], \f[B]\-\-no\-prompt\f[] -This option is a no\-op. +\f[B]-P\f[R], \f[B]\[en]no-prompt\f[R] +This option is a no-op. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-x\f[] \f[B]\-\-extended\-register\f[] +\f[B]-x\f[R] \f[B]\[en]extended-register\f[R] Enables extended register mode. -See the \f[I]Extended Register Mode\f[] subsection of the -\f[B]REGISTERS\f[] section for more information. +See the \f[I]Extended Register Mode\f[R] subsection of the +\f[B]REGISTERS\f[R] section for more information. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-e\f[] \f[I]expr\f[], \f[B]\-\-expression\f[]=\f[I]expr\f[] -Evaluates \f[I]expr\f[]. +\f[B]-e\f[R] \f[I]expr\f[R], \f[B]\[en]expression\f[R]=\f[I]expr\f[R] +Evaluates \f[I]expr\f[R]. If multiple expressions are given, they are evaluated in order. If files are given as well (see below), the expressions and files are evaluated in the order given. @@ -114,165 +112,167 @@ read in and evaluated first. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\-f\f[] \f[I]file\f[], \f[B]\-\-file\f[]=\f[I]file\f[] -Reads in \f[I]file\f[] and evaluates it, line by line, as though it were -read through \f[B]stdin\f[]. +\f[B]-f\f[R] \f[I]file\f[R], \f[B]\[en]file\f[R]=\f[I]file\f[R] +Reads in \f[I]file\f[R] and evaluates it, line by line, as though it +were read through \f[B]stdin\f[R]. If expressions are also given (see above), the expressions are evaluated in the order given. .RS .PP After processing all expressions and files, dc(1) will exit, unless -\f[B]\-\f[] (\f[B]stdin\f[]) was given as an argument at least once to -\f[B]\-f\f[] or \f[B]\-\-file\f[]. -However, if any other \f[B]\-e\f[], \f[B]\-\-expression\f[], -\f[B]\-f\f[], or \f[B]\-\-file\f[] arguments are given after that, bc(1) -will give a fatal error and exit. +\f[B]-\f[R] (\f[B]stdin\f[R]) was given as an argument at least once to +\f[B]-f\f[R] or \f[B]\[en]file\f[R]. +However, if any other \f[B]-e\f[R], \f[B]\[en]expression\f[R], +\f[B]-f\f[R], or \f[B]\[en]file\f[R] arguments are given after that, +bc(1) will give a fatal error and exit. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .PP -All long options are \f[B]non\-portable extensions\f[]. +All long options are \f[B]non-portable extensions\f[R]. .SH STDOUT .PP -Any non\-error output is written to \f[B]stdout\f[]. +Any non-error output is written to \f[B]stdout\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stdout\f[], so if \f[B]stdout\f[] is closed, as in \f[B]dc ->&\-\f[], it will quit with an error. -This is done so that dc(1) can report problems when \f[B]stdout\f[] is +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stdout\f[R], so if \f[B]stdout\f[R] is closed, as in +\f[B]dc >&-\f[R], it will quit with an error. +This is done so that dc(1) can report problems when \f[B]stdout\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stdout\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stdout\f[R] to \f[B]/dev/null\f[R]. .SH STDERR .PP -Any error output is written to \f[B]stderr\f[]. +Any error output is written to \f[B]stderr\f[R]. .PP -\f[B]Note\f[]: Unlike other dc(1) implementations, this dc(1) will issue -a fatal error (see the \f[B]EXIT STATUS\f[] section) if it cannot write -to \f[B]stderr\f[], so if \f[B]stderr\f[] is closed, as in \f[B]dc -2>&\-\f[], it will quit with an error. +\f[B]Note\f[R]: Unlike other dc(1) implementations, this dc(1) will +issue a fatal error (see the \f[B]EXIT STATUS\f[R] section) if it cannot +write to \f[B]stderr\f[R], so if \f[B]stderr\f[R] is closed, as in +\f[B]dc 2>&-\f[R], it will quit with an error. This is done so that dc(1) can exit with an error code when -\f[B]stderr\f[] is redirected to a file. +\f[B]stderr\f[R] is redirected to a file. .PP If there are scripts that depend on the behavior of other dc(1) implementations, it is recommended that those scripts be changed to -redirect \f[B]stderr\f[] to \f[B]/dev/null\f[]. +redirect \f[B]stderr\f[R] to \f[B]/dev/null\f[R]. .SH SYNTAX .PP Each item in the input source code, either a number (see the -\f[B]NUMBERS\f[] section) or a command (see the \f[B]COMMANDS\f[] +\f[B]NUMBERS\f[R] section) or a command (see the \f[B]COMMANDS\f[R] section), is processed and executed, in order. Input is processed immediately when entered. .PP -\f[B]ibase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +\f[B]ibase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to interpret constant numbers. -It is the "input" base, or the number base used for interpreting input -numbers. -\f[B]ibase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]ibase\f[] is \f[B]16\f[]. -The min allowable value for \f[B]ibase\f[] is \f[B]2\f[]. -The max allowable value for \f[B]ibase\f[] can be queried in dc(1) -programs with the \f[B]T\f[] command. -.PP -\f[B]obase\f[] is a register (see the \f[B]REGISTERS\f[] section) that +It is the \[lq]input\[rq] base, or the number base used for interpreting +input numbers. +\f[B]ibase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]ibase\f[R] is \f[B]16\f[R]. +The min allowable value for \f[B]ibase\f[R] is \f[B]2\f[R]. +The max allowable value for \f[B]ibase\f[R] can be queried in dc(1) +programs with the \f[B]T\f[R] command. +.PP +\f[B]obase\f[R] is a register (see the \f[B]REGISTERS\f[R] section) that determines how to output results. -It is the "output" base, or the number base used for outputting numbers. -\f[B]obase\f[] is initially \f[B]10\f[]. -The max allowable value for \f[B]obase\f[] is \f[B]DC_BASE_MAX\f[] and -can be queried with the \f[B]U\f[] command. -The min allowable value for \f[B]obase\f[] is \f[B]0\f[]. -If \f[B]obase\f[] is \f[B]0\f[], values are output in scientific -notation, and if \f[B]obase\f[] is \f[B]1\f[], values are output in +It is the \[lq]output\[rq] base, or the number base used for outputting +numbers. +\f[B]obase\f[R] is initially \f[B]10\f[R]. +The max allowable value for \f[B]obase\f[R] is \f[B]DC_BASE_MAX\f[R] and +can be queried with the \f[B]U\f[R] command. +The min allowable value for \f[B]obase\f[R] is \f[B]0\f[R]. +If \f[B]obase\f[R] is \f[B]0\f[R], values are output in scientific +notation, and if \f[B]obase\f[R] is \f[B]1\f[R], values are output in engineering notation. Otherwise, values are output in the specified base. .PP -Outputting in scientific and engineering notations are -\f[B]non\-portable extensions\f[]. +Outputting in scientific and engineering notations are \f[B]non-portable +extensions\f[R]. .PP -The \f[I]scale\f[] of an expression is the number of digits in the -result of the expression right of the decimal point, and \f[B]scale\f[] -is a register (see the \f[B]REGISTERS\f[] section) that sets the +The \f[I]scale\f[R] of an expression is the number of digits in the +result of the expression right of the decimal point, and \f[B]scale\f[R] +is a register (see the \f[B]REGISTERS\f[R] section) that sets the precision of any operations (with exceptions). -\f[B]scale\f[] is initially \f[B]0\f[]. -\f[B]scale\f[] cannot be negative. -The max allowable value for \f[B]scale\f[] can be queried in dc(1) -programs with the \f[B]V\f[] command. -.PP -\f[B]seed\f[] is a register containing the current seed for the -pseudo\-random number generator. -If the current value of \f[B]seed\f[] is queried and stored, then if it -is assigned to \f[B]seed\f[] later, the pseudo\-random number generator -is guaranteed to produce the same sequence of pseudo\-random numbers -that were generated after the value of \f[B]seed\f[] was first queried. -.PP -Multiple values assigned to \f[B]seed\f[] can produce the same sequence -of pseudo\-random numbers. -Likewise, when a value is assigned to \f[B]seed\f[], it is not -guaranteed that querying \f[B]seed\f[] immediately after will return the -same value. -In addition, the value of \f[B]seed\f[] will change after any call to -the \f[B]\[aq]\f[] command or the \f[B]"\f[] command that does not get -receive a value of \f[B]0\f[] or \f[B]1\f[]. -The maximum integer returned by the \f[B]\[aq]\f[] command can be -queried with the \f[B]W\f[] command. -.PP -\f[B]Note\f[]: The values returned by the pseudo\-random number -generator with the \f[B]\[aq]\f[] and \f[B]"\f[] commands are guaranteed -to \f[B]NOT\f[] be cryptographically secure. -This is a consequence of using a seeded pseudo\-random number generator. -However, they \f[B]are\f[] guaranteed to be reproducible with identical -\f[B]seed\f[] values. -.PP -The pseudo\-random number generator, \f[B]seed\f[], and all associated -operations are \f[B]non\-portable extensions\f[]. +\f[B]scale\f[R] is initially \f[B]0\f[R]. +\f[B]scale\f[R] cannot be negative. +The max allowable value for \f[B]scale\f[R] can be queried in dc(1) +programs with the \f[B]V\f[R] command. +.PP +\f[B]seed\f[R] is a register containing the current seed for the +pseudo-random number generator. +If the current value of \f[B]seed\f[R] is queried and stored, then if it +is assigned to \f[B]seed\f[R] later, the pseudo-random number generator +is guaranteed to produce the same sequence of pseudo-random numbers that +were generated after the value of \f[B]seed\f[R] was first queried. +.PP +Multiple values assigned to \f[B]seed\f[R] can produce the same sequence +of pseudo-random numbers. +Likewise, when a value is assigned to \f[B]seed\f[R], it is not +guaranteed that querying \f[B]seed\f[R] immediately after will return +the same value. +In addition, the value of \f[B]seed\f[R] will change after any call to +the \f[B]\[cq]\f[R] command or the \f[B]\[dq]\f[R] command that does not +get receive a value of \f[B]0\f[R] or \f[B]1\f[R]. +The maximum integer returned by the \f[B]\[cq]\f[R] command can be +queried with the \f[B]W\f[R] command. +.PP +\f[B]Note\f[R]: The values returned by the pseudo-random number +generator with the \f[B]\[cq]\f[R] and \f[B]\[dq]\f[R] commands are +guaranteed to \f[B]NOT\f[R] be cryptographically secure. +This is a consequence of using a seeded pseudo-random number generator. +However, they \f[B]are\f[R] guaranteed to be reproducible with identical +\f[B]seed\f[R] values. +.PP +The pseudo-random number generator, \f[B]seed\f[R], and all associated +operations are \f[B]non-portable extensions\f[R]. .SS Comments .PP -Comments go from \f[B]#\f[] until, and not including, the next newline. -This is a \f[B]non\-portable extension\f[]. +Comments go from \f[B]#\f[R] until, and not including, the next newline. +This is a \f[B]non-portable extension\f[R]. .SH NUMBERS .PP Numbers are strings made up of digits, uppercase letters up to -\f[B]F\f[], and at most \f[B]1\f[] period for a radix. -Numbers can have up to \f[B]DC_NUM_MAX\f[] digits. -Uppercase letters are equal to \f[B]9\f[] + their position in the -alphabet (i.e., \f[B]A\f[] equals \f[B]10\f[], or \f[B]9+1\f[]). +\f[B]F\f[R], and at most \f[B]1\f[R] period for a radix. +Numbers can have up to \f[B]DC_NUM_MAX\f[R] digits. +Uppercase letters are equal to \f[B]9\f[R] + their position in the +alphabet (i.e., \f[B]A\f[R] equals \f[B]10\f[R], or \f[B]9+1\f[R]). If a digit or letter makes no sense with the current value of -\f[B]ibase\f[], they are set to the value of the highest valid digit in -\f[B]ibase\f[]. +\f[B]ibase\f[R], they are set to the value of the highest valid digit in +\f[B]ibase\f[R]. .PP -Single\-character numbers (i.e., \f[B]A\f[] alone) take the value that +Single-character numbers (i.e., \f[B]A\f[R] alone) take the value that they would have if they were valid digits, regardless of the value of -\f[B]ibase\f[]. -This means that \f[B]A\f[] alone always equals decimal \f[B]10\f[] and -\f[B]F\f[] alone always equals decimal \f[B]15\f[]. +\f[B]ibase\f[R]. +This means that \f[B]A\f[R] alone always equals decimal \f[B]10\f[R] and +\f[B]F\f[R] alone always equals decimal \f[B]15\f[R]. .PP In addition, dc(1) accepts numbers in scientific notation. -These have the form \f[B]<number>e<integer>\f[]. -The power (the portion after the \f[B]e\f[]) must be an integer. -An example is \f[B]1.89237e9\f[], which is equal to \f[B]1892370000\f[]. -Negative exponents are also allowed, so \f[B]4.2890e_3\f[] is equal to -\f[B]0.0042890\f[]. -.PP -\f[B]WARNING\f[]: Both the number and the exponent in scientific -notation are interpreted according to the current \f[B]ibase\f[], but -the number is still multiplied by \f[B]10^exponent\f[] regardless of the -current \f[B]ibase\f[]. -For example, if \f[B]ibase\f[] is \f[B]16\f[] and dc(1) is given the -number string \f[B]FFeA\f[], the resulting decimal number will be -\f[B]2550000000000\f[], and if dc(1) is given the number string -\f[B]10e_4\f[], the resulting decimal number will be \f[B]0.0016\f[]. -.PP -Accepting input as scientific notation is a \f[B]non\-portable -extension\f[]. +These have the form \f[B]<number>e<integer>\f[R]. +The exponent (the portion after the \f[B]e\f[R]) must be an integer. +An example is \f[B]1.89237e9\f[R], which is equal to +\f[B]1892370000\f[R]. +Negative exponents are also allowed, so \f[B]4.2890e_3\f[R] is equal to +\f[B]0.0042890\f[R]. +.PP +\f[B]WARNING\f[R]: Both the number and the exponent in scientific +notation are interpreted according to the current \f[B]ibase\f[R], but +the number is still multiplied by \f[B]10\[ha]exponent\f[R] regardless +of the current \f[B]ibase\f[R]. +For example, if \f[B]ibase\f[R] is \f[B]16\f[R] and dc(1) is given the +number string \f[B]FFeA\f[R], the resulting decimal number will be +\f[B]2550000000000\f[R], and if dc(1) is given the number string +\f[B]10e_4\f[R], the resulting decimal number will be \f[B]0.0016\f[R]. +.PP +Accepting input as scientific notation is a \f[B]non-portable +extension\f[R]. .SH COMMANDS .PP The valid commands are listed below. @@ -282,15 +282,16 @@ These commands are used for printing. .PP Note that both scientific notation and engineering notation are available for printing numbers. -Scientific notation is activated by assigning \f[B]0\f[] to -\f[B]obase\f[] using \f[B]0o\f[], and engineering notation is activated -by assigning \f[B]1\f[] to \f[B]obase\f[] using \f[B]1o\f[]. -To deactivate them, just assign a different value to \f[B]obase\f[]. +Scientific notation is activated by assigning \f[B]0\f[R] to +\f[B]obase\f[R] using \f[B]0o\f[R], and engineering notation is +activated by assigning \f[B]1\f[R] to \f[B]obase\f[R] using +\f[B]1o\f[R]. +To deactivate them, just assign a different value to \f[B]obase\f[R]. .PP Printing numbers in scientific notation and/or engineering notation is a -\f[B]non\-portable extension\f[]. +\f[B]non-portable extension\f[R]. .TP -.B \f[B]p\f[] +\f[B]p\f[R] Prints the value on top of the stack, whether number or string, and prints a newline after. .RS @@ -298,27 +299,25 @@ prints a newline after. This does not alter the stack. .RE .TP -.B \f[B]n\f[] +\f[B]n\f[R] Prints the value on top of the stack, whether number or string, and pops it off of the stack. -.RS -.RE .TP -.B \f[B]P\f[] +\f[B]P\f[R] Pops a value off the stack. .RS .PP If the value is a number, it is truncated and the absolute value of the -result is printed as though \f[B]obase\f[] is \f[B]UCHAR_MAX+1\f[] and +result is printed as though \f[B]obase\f[R] is \f[B]UCHAR_MAX+1\f[R] and each digit is interpreted as an ASCII character, making it a byte stream. .PP If the value is a string, it is printed without a trailing newline. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]f\f[] +\f[B]f\f[R] Prints the entire contents of the stack, in order from newest to oldest, without altering anything. .RS @@ -329,461 +328,434 @@ Users should use this command when they get lost. .PP These are the commands used for arithmetic. .TP -.B \f[B]+\f[] +\f[B]+\f[R] The top two values are popped off the stack, added, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]\-\f[] +\f[B]-\f[R] The top two values are popped off the stack, subtracted, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to the max \f[I]scale\f[] of +The \f[I]scale\f[R] of the result is equal to the max \f[I]scale\f[R] of both operands. -.RS -.RE .TP -.B \f[B]*\f[] +\f[B]*\f[R] The top two values are popped off the stack, multiplied, and the result is pushed onto the stack. -If \f[B]a\f[] is the \f[I]scale\f[] of the first expression and -\f[B]b\f[] is the \f[I]scale\f[] of the second expression, the -\f[I]scale\f[] of the result is equal to -\f[B]min(a+b,max(scale,a,b))\f[] where \f[B]min()\f[] and \f[B]max()\f[] -return the obvious values. -.RS -.RE +If \f[B]a\f[R] is the \f[I]scale\f[R] of the first expression and +\f[B]b\f[R] is the \f[I]scale\f[R] of the second expression, the +\f[I]scale\f[R] of the result is equal to +\f[B]min(a+b,max(scale,a,b))\f[R] where \f[B]min()\f[R] and +\f[B]max()\f[R] return the obvious values. .TP -.B \f[B]/\f[] +\f[B]/\f[R] The top two values are popped off the stack, divided, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]%\f[] +\f[B]%\f[R] The top two values are popped off the stack, remaindered, and the result is pushed onto the stack. .RS .PP -Remaindering is equivalent to 1) Computing \f[B]a/b\f[] to current -\f[B]scale\f[], and 2) Using the result of step 1 to calculate -\f[B]a\-(a/b)*b\f[] to \f[I]scale\f[] -\f[B]max(scale+scale(b),scale(a))\f[]. +Remaindering is equivalent to 1) Computing \f[B]a/b\f[R] to current +\f[B]scale\f[R], and 2) Using the result of step 1 to calculate +\f[B]a-(a/b)*b\f[R] to \f[I]scale\f[R] +\f[B]max(scale+scale(b),scale(a))\f[R]. .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .RE .TP -.B \f[B]~\f[] +\f[B]\[ti]\f[R] The top two values are popped off the stack, divided and remaindered, and the results (divided first, remainder second) are pushed onto the stack. -This is equivalent to \f[B]x y / x y %\f[] except that \f[B]x\f[] and -\f[B]y\f[] are only evaluated once. +This is equivalent to \f[B]x y / x y %\f[R] except that \f[B]x\f[R] and +\f[B]y\f[R] are only evaluated once. .RS .PP -The first value popped off of the stack must be non\-zero. +The first value popped off of the stack must be non-zero. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]^\f[] +\f[B]\[ha]\f[R] The top two values are popped off the stack, the second is raised to the power of the first, and the result is pushed onto the stack. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be -non\-zero. +non-zero. .RE .TP -.B \f[B]v\f[] +\f[B]v\f[R] The top value is popped off the stack, its square root is computed, and the result is pushed onto the stack. -The \f[I]scale\f[] of the result is equal to \f[B]scale\f[]. +The \f[I]scale\f[R] of the result is equal to \f[B]scale\f[R]. .RS .PP -The value popped off of the stack must be non\-negative. +The value popped off of the stack must be non-negative. .RE .TP -.B \f[B]_\f[] -If this command \f[I]immediately\f[] precedes a number (i.e., no spaces +\f[B]_\f[R] +If this command \f[I]immediately\f[R] precedes a number (i.e., no spaces or other commands), then that number is input as a negative number. .RS .PP Otherwise, the top value on the stack is popped and copied, and the copy is negated and pushed onto the stack. -This behavior without a number is a \f[B]non\-portable extension\f[]. +This behavior without a number is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]b\f[] +\f[B]b\f[R] The top value is popped off the stack, and if it is zero, it is pushed back onto the stack. Otherwise, its absolute value is pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]|\f[] +\f[B]|\f[R] The top three values are popped off the stack, a modular exponentiation is computed, and the result is pushed onto the stack. .RS .PP The first value popped is used as the reduction modulus and must be an -integer and non\-zero. +integer and non-zero. The second value popped is used as the exponent and must be an integer -and non\-negative. +and non-negative. The third value popped is the base and must be an integer. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]$\f[] +\f[B]$\f[R] The top value is popped off the stack and copied, and the copy is truncated and pushed onto the stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]\@\f[] +\f[B]\[at]\f[R] The top two values are popped off the stack, and the precision of the second is set to the value of the first, whether by truncation or extension. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]H\f[] +\f[B]H\f[R] The top two values are popped off the stack, and the second is shifted left (radix shifted right) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]h\f[] +\f[B]h\f[R] The top two values are popped off the stack, and the second is shifted right (radix shifted left) to the value of the first. .RS .PP The first value popped off of the stack must be an integer and -non\-negative. +non-negative. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]G\f[] +\f[B]G\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if they are equal, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if they are equal, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]N\f[] -The top value is popped off of the stack, and if it a \f[B]0\f[], a -\f[B]1\f[] is pushed; otherwise, a \f[B]0\f[] is pushed. +\f[B]N\f[R] +The top value is popped off of the stack, and if it a \f[B]0\f[R], a +\f[B]1\f[R] is pushed; otherwise, a \f[B]0\f[R] is pushed. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B](\f[] +\f[B](\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than the second, or \f[B]0\f[] -otherwise. +\f[B]1\f[R] is pushed if the first is less than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]{\f[] +\f[B]{\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is less than or equal to the second, -or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is less than or equal to the second, +or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B])\f[] +\f[B])\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than the second, or -\f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than the second, or +\f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]}\f[] +\f[B]}\f[R] The top two values are popped off of the stack, they are compared, and a -\f[B]1\f[] is pushed if the first is greater than or equal to the -second, or \f[B]0\f[] otherwise. +\f[B]1\f[R] is pushed if the first is greater than or equal to the +second, or \f[B]0\f[R] otherwise. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]M\f[] +\f[B]M\f[R] The top two values are popped off of the stack. -If they are both non\-zero, a \f[B]1\f[] is pushed onto the stack. -If either of them is zero, or both of them are, then a \f[B]0\f[] is +If they are both non-zero, a \f[B]1\f[R] is pushed onto the stack. +If either of them is zero, or both of them are, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]&&\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]&&\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]m\f[] +\f[B]m\f[R] The top two values are popped off of the stack. -If at least one of them is non\-zero, a \f[B]1\f[] is pushed onto the +If at least one of them is non-zero, a \f[B]1\f[R] is pushed onto the stack. -If both of them are zero, then a \f[B]0\f[] is pushed onto the stack. +If both of them are zero, then a \f[B]0\f[R] is pushed onto the stack. .RS .PP -This is like the \f[B]||\f[] operator in bc(1), and it is \f[I]not\f[] a -short\-circuit operator. +This is like the \f[B]||\f[R] operator in bc(1), and it is \f[I]not\f[R] +a short-circuit operator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE -.SS Pseudo\-Random Number Generator +.SS Pseudo-Random Number Generator .PP -dc(1) has a built\-in pseudo\-random number generator. -These commands query the pseudo\-random number generator. -(See Parameters for more information about the \f[B]seed\f[] value that -controls the pseudo\-random number generator.) +dc(1) has a built-in pseudo-random number generator. +These commands query the pseudo-random number generator. +(See Parameters for more information about the \f[B]seed\f[R] value that +controls the pseudo-random number generator.) .PP -The pseudo\-random number generator is guaranteed to \f[B]NOT\f[] be +The pseudo-random number generator is guaranteed to \f[B]NOT\f[R] be cryptographically secure. .TP -.B \f[B]\[aq]\f[] -Generates an integer between 0 and \f[B]DC_RAND_MAX\f[], inclusive (see -the \f[B]LIMITS\f[] section). +\f[B]\[cq]\f[R] +Generates an integer between 0 and \f[B]DC_RAND_MAX\f[R], inclusive (see +the \f[B]LIMITS\f[R] section). .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]"\f[] -Pops a value off of the stack, which is used as an \f[B]exclusive\f[] +\f[B]\[dq]\f[R] +Pops a value off of the stack, which is used as an \f[B]exclusive\f[R] upper bound on the integer that will be generated. -If the bound is negative or is a non\-integer, an error is raised, and -dc(1) resets (see the \f[B]RESET\f[] section) while \f[B]seed\f[] +If the bound is negative or is a non-integer, an error is raised, and +dc(1) resets (see the \f[B]RESET\f[R] section) while \f[B]seed\f[R] remains unchanged. -If the bound is larger than \f[B]DC_RAND_MAX\f[], the higher bound is -honored by generating several pseudo\-random integers, multiplying them -by appropriate powers of \f[B]DC_RAND_MAX+1\f[], and adding them +If the bound is larger than \f[B]DC_RAND_MAX\f[R], the higher bound is +honored by generating several pseudo-random integers, multiplying them +by appropriate powers of \f[B]DC_RAND_MAX+1\f[R], and adding them together. Thus, the size of integer that can be generated with this command is unbounded. -Using this command will change the value of \f[B]seed\f[], unless the -operand is \f[B]0\f[] or \f[B]1\f[]. -In that case, \f[B]0\f[] is pushed onto the stack, and \f[B]seed\f[] is -\f[I]not\f[] changed. +Using this command will change the value of \f[B]seed\f[R], unless the +operand is \f[B]0\f[R] or \f[B]1\f[R]. +In that case, \f[B]0\f[R] is pushed onto the stack, and \f[B]seed\f[R] +is \f[I]not\f[R] changed. .RS .PP The generated integer is made as unbiased as possible, subject to the -limitations of the pseudo\-random number generator. +limitations of the pseudo-random number generator. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Stack Control .PP These commands control the stack. .TP -.B \f[B]c\f[] -Removes all items from ("clears") the stack. -.RS -.RE +\f[B]c\f[R] +Removes all items from (\[lq]clears\[rq]) the stack. .TP -.B \f[B]d\f[] -Copies the item on top of the stack ("duplicates") and pushes the copy -onto the stack. -.RS -.RE +\f[B]d\f[R] +Copies the item on top of the stack (\[lq]duplicates\[rq]) and pushes +the copy onto the stack. .TP -.B \f[B]r\f[] -Swaps ("reverses") the two top items on the stack. -.RS -.RE +\f[B]r\f[R] +Swaps (\[lq]reverses\[rq]) the two top items on the stack. .TP -.B \f[B]R\f[] -Pops ("removes") the top value from the stack. -.RS -.RE +\f[B]R\f[R] +Pops (\[lq]removes\[rq]) the top value from the stack. .SS Register Control .PP -These commands control registers (see the \f[B]REGISTERS\f[] section). +These commands control registers (see the \f[B]REGISTERS\f[R] section). .TP -.B \f[B]s\f[]\f[I]r\f[] +\f[B]s\f[R]\f[I]r\f[R] Pops the value off the top of the stack and stores it into register -\f[I]r\f[]. -.RS -.RE +\f[I]r\f[R]. .TP -.B \f[B]l\f[]\f[I]r\f[] -Copies the value in register \f[I]r\f[] and pushes it onto the stack. -This does not alter the contents of \f[I]r\f[]. -.RS -.RE +\f[B]l\f[R]\f[I]r\f[R] +Copies the value in register \f[I]r\f[R] and pushes it onto the stack. +This does not alter the contents of \f[I]r\f[R]. .TP -.B \f[B]S\f[]\f[I]r\f[] +\f[B]S\f[R]\f[I]r\f[R] Pops the value off the top of the (main) stack and pushes it onto the -stack of register \f[I]r\f[]. +stack of register \f[I]r\f[R]. The previous value of the register becomes inaccessible. -.RS -.RE .TP -.B \f[B]L\f[]\f[I]r\f[] -Pops the value off the top of the stack for register \f[I]r\f[] and push -it onto the main stack. -The previous value in the stack for register \f[I]r\f[], if any, is now -accessible via the \f[B]l\f[]\f[I]r\f[] command. -.RS -.RE +\f[B]L\f[R]\f[I]r\f[R] +Pops the value off the top of the stack for register \f[I]r\f[R] and +push it onto the main stack. +The previous value in the stack for register \f[I]r\f[R], if any, is now +accessible via the \f[B]l\f[R]\f[I]r\f[R] command. .SS Parameters .PP -These commands control the values of \f[B]ibase\f[], \f[B]obase\f[], -\f[B]scale\f[], and \f[B]seed\f[]. -Also see the \f[B]SYNTAX\f[] section. +These commands control the values of \f[B]ibase\f[R], \f[B]obase\f[R], +\f[B]scale\f[R], and \f[B]seed\f[R]. +Also see the \f[B]SYNTAX\f[R] section. .TP -.B \f[B]i\f[] +\f[B]i\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]ibase\f[], which must be between \f[B]2\f[] and \f[B]16\f[], +\f[B]ibase\f[R], which must be between \f[B]2\f[R] and \f[B]16\f[R], inclusive. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]o\f[] +\f[B]o\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]obase\f[], which must be between \f[B]0\f[] and -\f[B]DC_BASE_MAX\f[], inclusive (see the \f[B]LIMITS\f[] section and the -\f[B]NUMBERS\f[] section). +\f[B]obase\f[R], which must be between \f[B]0\f[R] and +\f[B]DC_BASE_MAX\f[R], inclusive (see the \f[B]LIMITS\f[R] section and +the \f[B]NUMBERS\f[R] section). .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]k\f[] +\f[B]k\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]scale\f[], which must be non\-negative. +\f[B]scale\f[R], which must be non-negative. .RS .PP -If the value on top of the stack has any \f[I]scale\f[], the -\f[I]scale\f[] is ignored. +If the value on top of the stack has any \f[I]scale\f[R], the +\f[I]scale\f[R] is ignored. .RE .TP -.B \f[B]j\f[] +\f[B]j\f[R] Pops the value off of the top of the stack and uses it to set -\f[B]seed\f[]. -The meaning of \f[B]seed\f[] is dependent on the current pseudo\-random +\f[B]seed\f[R]. +The meaning of \f[B]seed\f[R] is dependent on the current pseudo-random number generator but is guaranteed to not change except for new major versions. .RS .PP -The \f[I]scale\f[] and sign of the value may be significant. +The \f[I]scale\f[R] and sign of the value may be significant. .PP -If a previously used \f[B]seed\f[] value is used again, the -pseudo\-random number generator is guaranteed to produce the same -sequence of pseudo\-random numbers as it did when the \f[B]seed\f[] +If a previously used \f[B]seed\f[R] value is used again, the +pseudo-random number generator is guaranteed to produce the same +sequence of pseudo-random numbers as it did when the \f[B]seed\f[R] value was previously used. .PP -The exact value assigned to \f[B]seed\f[] is not guaranteed to be -returned if the \f[B]J\f[] command is used. -However, if \f[B]seed\f[] \f[I]does\f[] return a different value, both -values, when assigned to \f[B]seed\f[], are guaranteed to produce the -same sequence of pseudo\-random numbers. -This means that certain values assigned to \f[B]seed\f[] will not -produce unique sequences of pseudo\-random numbers. +The exact value assigned to \f[B]seed\f[R] is not guaranteed to be +returned if the \f[B]J\f[R] command is used. +However, if \f[B]seed\f[R] \f[I]does\f[R] return a different value, both +values, when assigned to \f[B]seed\f[R], are guaranteed to produce the +same sequence of pseudo-random numbers. +This means that certain values assigned to \f[B]seed\f[R] will not +produce unique sequences of pseudo-random numbers. .PP There is no limit to the length (number of significant decimal digits) -or \f[I]scale\f[] of the value that can be assigned to \f[B]seed\f[]. +or \f[I]scale\f[R] of the value that can be assigned to \f[B]seed\f[R]. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]I\f[] -Pushes the current value of \f[B]ibase\f[] onto the main stack. -.RS -.RE +\f[B]I\f[R] +Pushes the current value of \f[B]ibase\f[R] onto the main stack. .TP -.B \f[B]O\f[] -Pushes the current value of \f[B]obase\f[] onto the main stack. -.RS -.RE +\f[B]O\f[R] +Pushes the current value of \f[B]obase\f[R] onto the main stack. .TP -.B \f[B]K\f[] -Pushes the current value of \f[B]scale\f[] onto the main stack. -.RS -.RE +\f[B]K\f[R] +Pushes the current value of \f[B]scale\f[R] onto the main stack. .TP -.B \f[B]J\f[] -Pushes the current value of \f[B]seed\f[] onto the main stack. +\f[B]J\f[R] +Pushes the current value of \f[B]seed\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]T\f[] -Pushes the maximum allowable value of \f[B]ibase\f[] onto the main +\f[B]T\f[R] +Pushes the maximum allowable value of \f[B]ibase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]U\f[] -Pushes the maximum allowable value of \f[B]obase\f[] onto the main +\f[B]U\f[R] +Pushes the maximum allowable value of \f[B]obase\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]V\f[] -Pushes the maximum allowable value of \f[B]scale\f[] onto the main +\f[B]V\f[R] +Pushes the maximum allowable value of \f[B]scale\f[R] onto the main stack. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]W\f[] +\f[B]W\f[R] Pushes the maximum (inclusive) integer that can be generated with the -\f[B]\[aq]\f[] pseudo\-random number generator command. +\f[B]\[cq]\f[R] pseudo-random number generator command. .RS .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .SS Strings .PP The following commands control strings. .PP dc(1) can work with both numbers and strings, and registers (see the -\f[B]REGISTERS\f[] section) can hold both strings and numbers. +\f[B]REGISTERS\f[R] section) can hold both strings and numbers. dc(1) always knows whether the contents of a register are a string or a number. .PP @@ -791,18 +763,18 @@ While arithmetic operations have to have numbers, and will print an error if given a string, other commands accept strings. .PP Strings can also be executed as macros. -For example, if the string \f[B][1pR]\f[] is executed as a macro, then -the code \f[B]1pR\f[] is executed, meaning that the \f[B]1\f[] will be +For example, if the string \f[B][1pR]\f[R] is executed as a macro, then +the code \f[B]1pR\f[R] is executed, meaning that the \f[B]1\f[R] will be printed with a newline after and then popped from the stack. .TP -.B \f[B][\f[]\f[I]characters\f[]\f[B]]\f[] -Makes a string containing \f[I]characters\f[] and pushes it onto the +\f[B][\f[R]_characters_\f[B]]\f[R] +Makes a string containing \f[I]characters\f[R] and pushes it onto the stack. .RS .PP -If there are brackets (\f[B][\f[] and \f[B]]\f[]) in the string, then +If there are brackets (\f[B][\f[R] and \f[B]]\f[R]) in the string, then they must be balanced. -Unbalanced brackets can be escaped using a backslash (\f[B]\\\f[]) +Unbalanced brackets can be escaped using a backslash (\f[B]\[rs]\f[R]) character. .PP If there is a backslash character in the string, the character after it @@ -810,26 +782,26 @@ If there is a backslash character in the string, the character after it (first) backslash is not. .RE .TP -.B \f[B]a\f[] +\f[B]a\f[R] The value on top of the stack is popped. .RS .PP If it is a number, it is truncated and its absolute value is taken. -The result mod \f[B]UCHAR_MAX+1\f[] is calculated. -If that result is \f[B]0\f[], push an empty string; otherwise, push a -one\-character string where the character is the result of the mod +The result mod \f[B]UCHAR_MAX+1\f[R] is calculated. +If that result is \f[B]0\f[R], push an empty string; otherwise, push a +one-character string where the character is the result of the mod interpreted as an ASCII character. .PP If it is a string, then a new string is made. If the original string is empty, the new string is empty. If it is not, then the first character of the original string is used to -create the new string as a one\-character string. +create the new string as a one-character string. The new string is then pushed onto the stack. .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]x\f[] +\f[B]x\f[R] Pops a value off of the top of the stack. .RS .PP @@ -841,160 +813,154 @@ This behavior is the norm whenever a macro is executed, whether by this command or by the conditional execution commands below. .RE .TP -.B \f[B]>\f[]\f[I]r\f[] +\f[B]>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is greater than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP -For example, \f[B]0 1>a\f[] will execute the contents of register -\f[B]a\f[], and \f[B]1 0>a\f[] will not. +For example, \f[B]0 1>a\f[R] will execute the contents of register +\f[B]a\f[R], and \f[B]1 0>a\f[R] will not. .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!>\f[]\f[I]r\f[] +\f[B]!>\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not greater than the second (less than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!>\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!>\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]<\f[]\f[I]r\f[] +\f[B]<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is less than the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!<\f[]\f[I]r\f[] +\f[B]!<\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not less than the second (greater than or equal -to), then the contents of register \f[I]r\f[] are executed. +to), then the contents of register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!<\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!<\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]=\f[]\f[I]r\f[] +\f[B]=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is equal to the second, then the contents of register -\f[I]r\f[] are executed. +\f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]!=\f[]\f[I]r\f[] +\f[B]!=\f[R]\f[I]r\f[R] Pops two values off of the stack that must be numbers and compares them. If the first value is not equal to the second, then the contents of -register \f[I]r\f[] are executed. +register \f[I]r\f[R] are executed. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .RE .TP -.B \f[B]!=\f[]\f[I]r\f[]\f[B]e\f[]\f[I]s\f[] -Like the above, but will execute register \f[I]s\f[] if the comparison +\f[B]!=\f[R]\f[I]r\f[R]\f[B]e\f[R]\f[I]s\f[R] +Like the above, but will execute register \f[I]s\f[R] if the comparison fails. .RS .PP If either or both of the values are not numbers, dc(1) will raise an -error and reset (see the \f[B]RESET\f[] section). +error and reset (see the \f[B]RESET\f[R] section). .PP -This is a \f[B]non\-portable extension\f[]. +This is a \f[B]non-portable extension\f[R]. .RE .TP -.B \f[B]?\f[] -Reads a line from the \f[B]stdin\f[] and executes it. +\f[B]?\f[R] +Reads a line from the \f[B]stdin\f[R] and executes it. This is to allow macros to request input from users. -.RS -.RE .TP -.B \f[B]q\f[] +\f[B]q\f[R] During execution of a macro, this exits the execution of that macro and the execution of the macro that executed it. If there are no macros, or only one macro executing, dc(1) exits. -.RS -.RE .TP -.B \f[B]Q\f[] -Pops a value from the stack which must be non\-negative and is used the +\f[B]Q\f[R] +Pops a value from the stack which must be non-negative and is used the number of macro executions to pop off of the execution stack. If the number of levels to pop is greater than the number of executing macros, dc(1) exits. -.RS -.RE .SS Status .PP These commands query status of the stack or its top value. .TP -.B \f[B]Z\f[] +\f[B]Z\f[R] Pops a value off of the stack. .RS .PP @@ -1004,37 +970,31 @@ it has and pushes the result. If it is a string, pushes the number of characters the string has. .RE .TP -.B \f[B]X\f[] +\f[B]X\f[R] Pops a value off of the stack. .RS .PP -If it is a number, pushes the \f[I]scale\f[] of the value onto the +If it is a number, pushes the \f[I]scale\f[R] of the value onto the stack. .PP -If it is a string, pushes \f[B]0\f[]. +If it is a string, pushes \f[B]0\f[R]. .RE .TP -.B \f[B]z\f[] +\f[B]z\f[R] Pushes the current stack depth (before execution of this command). -.RS -.RE .SS Arrays .PP These commands manipulate arrays. .TP -.B \f[B]:\f[]\f[I]r\f[] +\f[B]:\f[R]\f[I]r\f[R] Pops the top two values off of the stack. -The second value will be stored in the array \f[I]r\f[] (see the -\f[B]REGISTERS\f[] section), indexed by the first value. -.RS -.RE +The second value will be stored in the array \f[I]r\f[R] (see the +\f[B]REGISTERS\f[R] section), indexed by the first value. .TP -.B \f[B];\f[]\f[I]r\f[] +\f[B];\f[R]\f[I]r\f[R] Pops the value on top of the stack and uses it as an index into the -array \f[I]r\f[]. +array \f[I]r\f[R]. The selected value is then pushed onto the stack. -.RS -.RE .SH REGISTERS .PP Registers are names that can store strings, numbers, and arrays. @@ -1042,31 +1002,31 @@ Registers are names that can store strings, numbers, and arrays. .PP Each register is also its own stack, so the current register value is the top of the stack for the register. -All registers, when first referenced, have one value (\f[B]0\f[]) in +All registers, when first referenced, have one value (\f[B]0\f[R]) in their stack. .PP -In non\-extended register mode, a register name is just the single +In non-extended register mode, a register name is just the single character that follows any command that needs a register name. -The only exception is a newline (\f[B]\[aq]\\n\[aq]\f[]); it is a parse +The only exception is a newline (\f[B]`\[rs]n'\f[R]); it is a parse error for a newline to be used as a register name. .SS Extended Register Mode .PP Unlike most other dc(1) implentations, this dc(1) provides nearly unlimited amounts of registers, if extended register mode is enabled. .PP -If extended register mode is enabled (\f[B]\-x\f[] or -\f[B]\-\-extended\-register\f[] command\-line arguments are given), then -normal single character registers are used \f[I]unless\f[] the character -immediately following a command that needs a register name is a space -(according to \f[B]isspace()\f[]) and not a newline -(\f[B]\[aq]\\n\[aq]\f[]). +If extended register mode is enabled (\f[B]-x\f[R] or +\f[B]\[en]extended-register\f[R] command-line arguments are given), then +normal single character registers are used \f[I]unless\f[R] the +character immediately following a command that needs a register name is +a space (according to \f[B]isspace()\f[R]) and not a newline +(\f[B]`\[rs]n'\f[R]). .PP In that case, the register name is found according to the regex -\f[B][a\-z][a\-z0\-9_]*\f[] (like bc(1) identifiers), and it is a parse -error if the next non\-space characters do not match that regex. +\f[B][a-z][a-z0-9_]*\f[R] (like bc(1) identifiers), and it is a parse +error if the next non-space characters do not match that regex. .SH RESET .PP -When dc(1) encounters an error or a signal that it has a non\-default +When dc(1) encounters an error or a signal that it has a non-default handler for, it resets. This means that several things happen. .PP @@ -1079,316 +1039,283 @@ Then the execution point is set so that any code waiting to execute Thus, when dc(1) resets, it skips any remaining code waiting to be executed. Then, if it is interactive mode, and the error was not a fatal error -(see the \f[B]EXIT STATUS\f[] section), it asks for more input; +(see the \f[B]EXIT STATUS\f[R] section), it asks for more input; otherwise, it exits with the appropriate return code. .SH PERFORMANCE .PP -Most dc(1) implementations use \f[B]char\f[] types to calculate the -value of \f[B]1\f[] decimal digit at a time, but that can be slow. +Most dc(1) implementations use \f[B]char\f[R] types to calculate the +value of \f[B]1\f[R] decimal digit at a time, but that can be slow. This dc(1) does something different. .PP -It uses large integers to calculate more than \f[B]1\f[] decimal digit +It uses large integers to calculate more than \f[B]1\f[R] decimal digit at a time. -If built in a environment where \f[B]DC_LONG_BIT\f[] (see the -\f[B]LIMITS\f[] section) is \f[B]64\f[], then each integer has -\f[B]9\f[] decimal digits. -If built in an environment where \f[B]DC_LONG_BIT\f[] is \f[B]32\f[] -then each integer has \f[B]4\f[] decimal digits. +If built in a environment where \f[B]DC_LONG_BIT\f[R] (see the +\f[B]LIMITS\f[R] section) is \f[B]64\f[R], then each integer has +\f[B]9\f[R] decimal digits. +If built in an environment where \f[B]DC_LONG_BIT\f[R] is \f[B]32\f[R] +then each integer has \f[B]4\f[R] decimal digits. This value (the number of decimal digits per large integer) is called -\f[B]DC_BASE_DIGS\f[]. +\f[B]DC_BASE_DIGS\f[R]. .PP In addition, this dc(1) uses an even larger integer for overflow checking. -This integer type depends on the value of \f[B]DC_LONG_BIT\f[], but is +This integer type depends on the value of \f[B]DC_LONG_BIT\f[R], but is always at least twice as large as the integer type used to store digits. .SH LIMITS .PP The following are the limits on dc(1): .TP -.B \f[B]DC_LONG_BIT\f[] -The number of bits in the \f[B]long\f[] type in the environment where +\f[B]DC_LONG_BIT\f[R] +The number of bits in the \f[B]long\f[R] type in the environment where dc(1) was built. This determines how many decimal digits can be stored in a single large -integer (see the \f[B]PERFORMANCE\f[] section). -.RS -.RE +integer (see the \f[B]PERFORMANCE\f[R] section). .TP -.B \f[B]DC_BASE_DIGS\f[] +\f[B]DC_BASE_DIGS\f[R] The number of decimal digits per large integer (see the -\f[B]PERFORMANCE\f[] section). -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +\f[B]PERFORMANCE\f[R] section). +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_POW\f[] +\f[B]DC_BASE_POW\f[R] The max decimal number that each large integer can store (see -\f[B]DC_BASE_DIGS\f[]) plus \f[B]1\f[]. -Depends on \f[B]DC_BASE_DIGS\f[]. -.RS -.RE +\f[B]DC_BASE_DIGS\f[R]) plus \f[B]1\f[R]. +Depends on \f[B]DC_BASE_DIGS\f[R]. .TP -.B \f[B]DC_OVERFLOW_MAX\f[] -The max number that the overflow type (see the \f[B]PERFORMANCE\f[] +\f[B]DC_OVERFLOW_MAX\f[R] +The max number that the overflow type (see the \f[B]PERFORMANCE\f[R] section) can hold. -Depends on \f[B]DC_LONG_BIT\f[]. -.RS -.RE +Depends on \f[B]DC_LONG_BIT\f[R]. .TP -.B \f[B]DC_BASE_MAX\f[] +\f[B]DC_BASE_MAX\f[R] The maximum output base. -Set at \f[B]DC_BASE_POW\f[]. -.RS -.RE +Set at \f[B]DC_BASE_POW\f[R]. .TP -.B \f[B]DC_DIM_MAX\f[] +\f[B]DC_DIM_MAX\f[R] The maximum size of arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .TP -.B \f[B]DC_SCALE_MAX\f[] -The maximum \f[B]scale\f[]. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +\f[B]DC_SCALE_MAX\f[R] +The maximum \f[B]scale\f[R]. +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_STRING_MAX\f[] +\f[B]DC_STRING_MAX\f[R] The maximum length of strings. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NAME_MAX\f[] +\f[B]DC_NAME_MAX\f[R] The maximum length of identifiers. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_NUM_MAX\f[] +\f[B]DC_NUM_MAX\f[R] The maximum length of a number (in decimal digits), which includes digits after the decimal point. -Set at \f[B]DC_OVERFLOW_MAX\-1\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX-1\f[R]. .TP -.B \f[B]DC_RAND_MAX\f[] -The maximum integer (inclusive) returned by the \f[B]\[aq]\f[] command, +\f[B]DC_RAND_MAX\f[R] +The maximum integer (inclusive) returned by the \f[B]\[cq]\f[R] command, if dc(1). -Set at \f[B]2^DC_LONG_BIT\-1\f[]. -.RS -.RE +Set at \f[B]2\[ha]DC_LONG_BIT-1\f[R]. .TP -.B Exponent +Exponent The maximum allowable exponent (positive or negative). -Set at \f[B]DC_OVERFLOW_MAX\f[]. -.RS -.RE +Set at \f[B]DC_OVERFLOW_MAX\f[R]. .TP -.B Number of vars +Number of vars The maximum number of vars/arrays. -Set at \f[B]SIZE_MAX\-1\f[]. -.RS -.RE +Set at \f[B]SIZE_MAX-1\f[R]. .PP -These limits are meant to be effectively non\-existent; the limits are -so large (at least on 64\-bit machines) that there should not be any -point at which they become a problem. +These limits are meant to be effectively non-existent; the limits are so +large (at least on 64-bit machines) that there should not be any point +at which they become a problem. In fact, memory should be exhausted before these limits should be hit. .SH ENVIRONMENT VARIABLES .PP dc(1) recognizes the following environment variables: .TP -.B \f[B]DC_ENV_ARGS\f[] -This is another way to give command\-line arguments to dc(1). -They should be in the same format as all other command\-line arguments. +\f[B]DC_ENV_ARGS\f[R] +This is another way to give command-line arguments to dc(1). +They should be in the same format as all other command-line arguments. These are always processed first, so any files given in -\f[B]DC_ENV_ARGS\f[] will be processed before arguments and files given -on the command\-line. -This gives the user the ability to set up "standard" options and files -to be used at every invocation. +\f[B]DC_ENV_ARGS\f[R] will be processed before arguments and files given +on the command-line. +This gives the user the ability to set up \[lq]standard\[rq] options and +files to be used at every invocation. The most useful thing for such files to contain would be useful functions that the user might want every time dc(1) runs. -Another use would be to use the \f[B]\-e\f[] option to set -\f[B]scale\f[] to a value other than \f[B]0\f[]. +Another use would be to use the \f[B]-e\f[R] option to set +\f[B]scale\f[R] to a value other than \f[B]0\f[R]. .RS .PP -The code that parses \f[B]DC_ENV_ARGS\f[] will correctly handle quoted +The code that parses \f[B]DC_ENV_ARGS\f[R] will correctly handle quoted arguments, but it does not understand escape sequences. -For example, the string \f[B]"/home/gavin/some dc file.dc"\f[] will be -correctly parsed, but the string \f[B]"/home/gavin/some "dc" -file.dc"\f[] will include the backslashes. -.PP -The quote parsing will handle either kind of quotes, \f[B]\[aq]\f[] or -\f[B]"\f[]. -Thus, if you have a file with any number of single quotes in the name, -you can use double quotes as the outside quotes, as in \f[B]"some -\[aq]bc\[aq] file.bc"\f[], and vice versa if you have a file with double -quotes. +For example, the string \f[B]\[lq]/home/gavin/some dc file.dc\[rq]\f[R] +will be correctly parsed, but the string \f[B]\[lq]/home/gavin/some +\[dq]dc\[dq] file.dc\[rq]\f[R] will include the backslashes. +.PP +The quote parsing will handle either kind of quotes, \f[B]\[cq]\f[R] or +\f[B]\[lq]\f[R]. Thus, if you have a file with any number of single +quotes in the name, you can use double quotes as the outside quotes, as +in \f[B]\[rq]some `bc' file.bc\[dq]\f[R], and vice versa if you have a +file with double quotes. However, handling a file with both kinds of quotes in -\f[B]DC_ENV_ARGS\f[] is not supported due to the complexity of the -parsing, though such files are still supported on the command\-line -where the parsing is done by the shell. +\f[B]DC_ENV_ARGS\f[R] is not supported due to the complexity of the +parsing, though such files are still supported on the command-line where +the parsing is done by the shell. .RE .TP -.B \f[B]DC_LINE_LENGTH\f[] +\f[B]DC_LINE_LENGTH\f[R] If this environment variable exists and contains an integer that is -greater than \f[B]1\f[] and is less than \f[B]UINT16_MAX\f[] -(\f[B]2^16\-1\f[]), dc(1) will output lines to that length, including -the backslash newline combo. -The default line length is \f[B]70\f[]. -.RS -.RE +greater than \f[B]1\f[R] and is less than \f[B]UINT16_MAX\f[R] +(\f[B]2\[ha]16-1\f[R]), dc(1) will output lines to that length, +including the backslash newline combo. +The default line length is \f[B]70\f[R]. .TP -.B \f[B]DC_EXPR_EXIT\f[] +\f[B]DC_EXPR_EXIT\f[R] If this variable exists (no matter the contents), dc(1) will exit immediately after executing expressions and files given by the -\f[B]\-e\f[] and/or \f[B]\-f\f[] command\-line options (and any +\f[B]-e\f[R] and/or \f[B]-f\f[R] command-line options (and any equivalents). -.RS -.RE .SH EXIT STATUS .PP dc(1) returns the following exit statuses: .TP -.B \f[B]0\f[] +\f[B]0\f[R] No error. -.RS -.RE .TP -.B \f[B]1\f[] +\f[B]1\f[R] A math error occurred. -This follows standard practice of using \f[B]1\f[] for expected errors, +This follows standard practice of using \f[B]1\f[R] for expected errors, since math errors will happen in the process of normal execution. .RS .PP -Math errors include divide by \f[B]0\f[], taking the square root of a +Math errors include divide by \f[B]0\f[R], taking the square root of a negative number, using a negative number as a bound for the -pseudo\-random number generator, attempting to convert a negative number +pseudo-random number generator, attempting to convert a negative number to a hardware integer, overflow when converting a number to a hardware -integer, and attempting to use a non\-integer where an integer is +integer, and attempting to use a non-integer where an integer is required. .PP Converting to a hardware integer happens for the second operand of the -power (\f[B]^\f[]), places (\f[B]\@\f[]), left shift (\f[B]H\f[]), and -right shift (\f[B]h\f[]) operators. +power (\f[B]\[ha]\f[R]), places (\f[B]\[at]\f[R]), left shift +(\f[B]H\f[R]), and right shift (\f[B]h\f[R]) operators. .RE .TP -.B \f[B]2\f[] +\f[B]2\f[R] A parse error occurred. .RS .PP -Parse errors include unexpected \f[B]EOF\f[], using an invalid +Parse errors include unexpected \f[B]EOF\f[R], using an invalid character, failing to find the end of a string or comment, and using a token where it is invalid. .RE .TP -.B \f[B]3\f[] +\f[B]3\f[R] A runtime error occurred. .RS .PP -Runtime errors include assigning an invalid number to \f[B]ibase\f[], -\f[B]obase\f[], or \f[B]scale\f[]; give a bad expression to a -\f[B]read()\f[] call, calling \f[B]read()\f[] inside of a -\f[B]read()\f[] call, type errors, and attempting an operation when the +Runtime errors include assigning an invalid number to \f[B]ibase\f[R], +\f[B]obase\f[R], or \f[B]scale\f[R]; give a bad expression to a +\f[B]read()\f[R] call, calling \f[B]read()\f[R] inside of a +\f[B]read()\f[R] call, type errors, and attempting an operation when the stack has too few elements. .RE .TP -.B \f[B]4\f[] +\f[B]4\f[R] A fatal error occurred. .RS .PP Fatal errors include memory allocation errors, I/O errors, failing to open files, attempting to use files that do not have only ASCII characters (dc(1) only accepts ASCII characters), attempting to open a -directory as a file, and giving invalid command\-line options. +directory as a file, and giving invalid command-line options. .RE .PP -The exit status \f[B]4\f[] is special; when a fatal error occurs, dc(1) -always exits and returns \f[B]4\f[], no matter what mode dc(1) is in. +The exit status \f[B]4\f[R] is special; when a fatal error occurs, dc(1) +always exits and returns \f[B]4\f[R], no matter what mode dc(1) is in. .PP The other statuses will only be returned when dc(1) is not in -interactive mode (see the \f[B]INTERACTIVE MODE\f[] section), since -dc(1) resets its state (see the \f[B]RESET\f[] section) and accepts more -input when one of those errors occurs in interactive mode. +interactive mode (see the \f[B]INTERACTIVE MODE\f[R] section), since +dc(1) resets its state (see the \f[B]RESET\f[R] section) and accepts +more input when one of those errors occurs in interactive mode. This is also the case when interactive mode is forced by the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .PP These exit statuses allow dc(1) to be used in shell scripting with error checking, and its normal behavior can be forced by using the -\f[B]\-i\f[] flag or \f[B]\-\-interactive\f[] option. +\f[B]-i\f[R] flag or \f[B]\[en]interactive\f[R] option. .SH INTERACTIVE MODE .PP -Like bc(1), dc(1) has an interactive mode and a non\-interactive mode. -Interactive mode is turned on automatically when both \f[B]stdin\f[] and -\f[B]stdout\f[] are hooked to a terminal, but the \f[B]\-i\f[] flag and -\f[B]\-\-interactive\f[] option can turn it on in other cases. +Like bc(1), dc(1) has an interactive mode and a non-interactive mode. +Interactive mode is turned on automatically when both \f[B]stdin\f[R] +and \f[B]stdout\f[R] are hooked to a terminal, but the \f[B]-i\f[R] flag +and \f[B]\[en]interactive\f[R] option can turn it on in other cases. .PP In interactive mode, dc(1) attempts to recover from errors (see the -\f[B]RESET\f[] section), and in normal execution, flushes -\f[B]stdout\f[] as soon as execution is done for the current input. +\f[B]RESET\f[R] section), and in normal execution, flushes +\f[B]stdout\f[R] as soon as execution is done for the current input. .SH TTY MODE .PP -If \f[B]stdin\f[], \f[B]stdout\f[], and \f[B]stderr\f[] are all -connected to a TTY, dc(1) turns on "TTY mode." +If \f[B]stdin\f[R], \f[B]stdout\f[R], and \f[B]stderr\f[R] are all +connected to a TTY, dc(1) turns on \[lq]TTY mode.\[rq] .PP TTY mode is required for history to be enabled (see the \f[B]COMMAND -LINE HISTORY\f[] section). -It is also required to enable special handling for \f[B]SIGINT\f[] +LINE HISTORY\f[R] section). +It is also required to enable special handling for \f[B]SIGINT\f[R] signals. .PP TTY mode is different from interactive mode because interactive mode is required in the bc(1) specification (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html), -and interactive mode requires only \f[B]stdin\f[] and \f[B]stdout\f[] to -be connected to a terminal. +and interactive mode requires only \f[B]stdin\f[R] and \f[B]stdout\f[R] +to be connected to a terminal. .SH SIGNAL HANDLING .PP -Sending a \f[B]SIGINT\f[] will cause dc(1) to stop execution of the +Sending a \f[B]SIGINT\f[R] will cause dc(1) to stop execution of the current input. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), it will -reset (see the \f[B]RESET\f[] section). +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), it will +reset (see the \f[B]RESET\f[R] section). Otherwise, it will clean up and exit. .PP -Note that "current input" can mean one of two things. -If dc(1) is processing input from \f[B]stdin\f[] in TTY mode, it will +Note that \[lq]current input\[rq] can mean one of two things. +If dc(1) is processing input from \f[B]stdin\f[R] in TTY mode, it will ask for more input. If dc(1) is processing input from a file in TTY mode, it will stop processing the file and start processing the next file, if one exists, -or ask for input from \f[B]stdin\f[] if no other file exists. +or ask for input from \f[B]stdin\f[R] if no other file exists. .PP -This means that if a \f[B]SIGINT\f[] is sent to dc(1) as it is executing -a file, it can seem as though dc(1) did not respond to the signal since -it will immediately start executing the next file. +This means that if a \f[B]SIGINT\f[R] is sent to dc(1) as it is +executing a file, it can seem as though dc(1) did not respond to the +signal since it will immediately start executing the next file. This is by design; most files that users execute when interacting with dc(1) have function definitions, which are quick to parse. If a file takes a long time to execute, there may be a bug in that file. The rest of the files could still be executed without problem, allowing the user to continue. .PP -\f[B]SIGTERM\f[] and \f[B]SIGQUIT\f[] cause dc(1) to clean up and exit, -and it uses the default handler for all other signals. -The one exception is \f[B]SIGHUP\f[]; in that case, when dc(1) is in TTY -mode, a \f[B]SIGHUP\f[] will cause dc(1) to clean up and exit. +\f[B]SIGTERM\f[R] and \f[B]SIGQUIT\f[R] cause dc(1) to clean up and +exit, and it uses the default handler for all other signals. +The one exception is \f[B]SIGHUP\f[R]; in that case, when dc(1) is in +TTY mode, a \f[B]SIGHUP\f[R] will cause dc(1) to clean up and exit. .SH COMMAND LINE HISTORY .PP -dc(1) supports interactive command\-line editing. -If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[] section), history is +dc(1) supports interactive command-line editing. +If dc(1) is in TTY mode (see the \f[B]TTY MODE\f[R] section), history is enabled. Previous lines can be recalled and edited with the arrow keys. .PP -\f[B]Note\f[]: tabs are converted to 8 spaces. +\f[B]Note\f[R]: tabs are converted to 8 spaces. .SH LOCALES .PP This dc(1) ships with support for adding error messages for different -locales and thus, supports \f[B]LC_MESSAGS\f[]. +locales and thus, supports \f[B]LC_MESSAGS\f[R]. .SH SEE ALSO .PP bc(1) .SH STANDARDS .PP The dc(1) utility operators are compliant with the operators in the -bc(1) IEEE Std 1003.1\-2017 -(“POSIX.1\-2017”) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) +bc(1) IEEE Std 1003.1-2017 +(\[lq]POSIX.1-2017\[rq]) (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html) specification. .SH BUGS .PP @@ -1397,4 +1324,4 @@ Report bugs at https://git.yzena.com/gavin/bc. .SH AUTHOR .PP Gavin D. -Howard <yzena.tech@gmail.com> and contributors. +Howard <gavin@yzena.com> and contributors. diff --git a/contrib/bc/manuals/dc/P.1.md b/contrib/bc/manuals/dc/P.1.md index 41aad658bb3d..65771f6c73e1 100644 --- a/contrib/bc/manuals/dc/P.1.md +++ b/contrib/bc/manuals/dc/P.1.md @@ -30,7 +30,7 @@ POSSIBILITY OF SUCH DAMAGE. # Name -dc - arbitrary-precision reverse-Polish notation calculator +dc - arbitrary-precision decimal reverse-Polish notation calculator # SYNOPSIS @@ -219,9 +219,9 @@ if they were valid digits, regardless of the value of **ibase**. This means that **15**. In addition, dc(1) accepts numbers in scientific notation. These have the form -**\<number\>e\<integer\>**. The power (the portion after the **e**) must be an -integer. An example is **1.89237e9**, which is equal to **1892370000**. Negative -exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. +**\<number\>e\<integer\>**. The exponent (the portion after the **e**) must be +an integer. An example is **1.89237e9**, which is equal to **1892370000**. +Negative exponents are also allowed, so **4.2890e_3** is equal to **0.0042890**. **WARNING**: Both the number and the exponent in scientific notation are interpreted according to the current **ibase**, but the number is still @@ -336,7 +336,8 @@ These are the commands used for arithmetic. **\^** : The top two values are popped off the stack, the second is raised to the - power of the first, and the result is pushed onto the stack. + power of the first, and the result is pushed onto the stack. The *scale* of + the result is equal to **scale**. The first value popped off of the stack must be an integer, and if that value is negative, the second value popped off of the stack must be @@ -1184,6 +1185,6 @@ None are known. Report bugs at https://git.yzena.com/gavin/bc. # AUTHOR -Gavin D. Howard <yzena.tech@gmail.com> and contributors. +Gavin D. Howard <gavin@yzena.com> and contributors. [1]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/bc.html diff --git a/contrib/bc/manuals/header.txt b/contrib/bc/manuals/header.txt new file mode 100644 index 000000000000..071157ebd135 --- /dev/null +++ b/contrib/bc/manuals/header.txt @@ -0,0 +1,27 @@ +.\" +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.\" Copyright (c) 2018-2020 Gavin D. Howard and contributors. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions are met: +.\" +.\" * Redistributions of source code must retain the above copyright notice, +.\" this list of conditions and the following disclaimer. +.\" +.\" * Redistributions in binary form must reproduce the above copyright notice, +.\" this list of conditions and the following disclaimer in the documentation +.\" and/or other materials provided with the distribution. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +.\" POSSIBILITY OF SUCH DAMAGE. +.\" diff --git a/contrib/bc/manuals/header_bc.txt b/contrib/bc/manuals/header_bc.txt new file mode 100644 index 000000000000..fa1a54f85693 --- /dev/null +++ b/contrib/bc/manuals/header_bc.txt @@ -0,0 +1 @@ +.TH "BC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" diff --git a/contrib/bc/manuals/header_bcl.txt b/contrib/bc/manuals/header_bcl.txt new file mode 100644 index 000000000000..ba9338aadad9 --- /dev/null +++ b/contrib/bc/manuals/header_bcl.txt @@ -0,0 +1 @@ +.TH "BCL" "3" "October 2020" "Gavin D. Howard" "Libraries Manual" diff --git a/contrib/bc/manuals/header_dc.txt b/contrib/bc/manuals/header_dc.txt new file mode 100644 index 000000000000..b0e8b204f4ee --- /dev/null +++ b/contrib/bc/manuals/header_dc.txt @@ -0,0 +1 @@ +.TH "DC" "1" "October 2020" "Gavin D. Howard" "General Commands Manual" diff --git a/contrib/bc/release.sh b/contrib/bc/release.sh index d6cc74b43118..bd9c33e55da6 100755 --- a/contrib/bc/release.sh +++ b/contrib/bc/release.sh @@ -263,6 +263,35 @@ runtestseries() { done } +runlibtests() { + + _runlibtests_CFLAGS="$1" + shift + + _runlibtests_CC="$1" + shift + + _runlibtests_configure_flags="$1" + shift + + _runlibtests_run_tests="$1" + shift + + _runlibtests_configure_flags="$_runlibtests_configure_flags -a" + + build "$_runlibtests_CFLAGS" "$_runlibtests_CC" "$_runlibtests_configure_flags" 1 64 + + if [ "$_runlibtests_run_tests" -ne 0 ]; then + runtest + fi + + build "$_runlibtests_CFLAGS" "$_runlibtests_CC" "$_runlibtests_configure_flags" 1 32 + + if [ "$_runlibtests_run_tests" -ne 0 ]; then + runtest + fi +} + runtests() { _runtests_CFLAGS="$1" @@ -326,6 +355,12 @@ debug() { if [ "$_debug_CC" = "clang" -a "$run_sanitizers" -ne 0 ]; then runtests "$debug -fsanitize=undefined" "$_debug_CC" "-g" "$_debug_run_tests" fi + + runlibtests "$debug" "$_debug_CC" "-g" "$_debug_run_tests" + + if [ "$_debug_CC" = "clang" -a "$run_sanitizers" -ne 0 ]; then + runlibtests "$debug -fsanitize=undefined" "$_debug_CC" "-g" "$_debug_run_tests" + fi } release() { @@ -337,6 +372,8 @@ release() { shift runtests "$release" "$_release_CC" "-O3" "$_release_run_tests" + + runlibtests "$release" "$_release_CC" "-O3" "$_release_run_tests" } reldebug() { @@ -353,6 +390,13 @@ reldebug() { runtests "$debug -fsanitize=address" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests" runtests "$debug -fsanitize=memory" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests" fi + + runlibtests "$debug" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests" + + if [ "$_reldebug_CC" = "clang" -a "$run_sanitizers" -ne 0 ]; then + runlibtests "$debug -fsanitize=address" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests" + runlibtests "$debug -fsanitize=memory" "$_reldebug_CC" "-gO3" "$_reldebug_run_tests" + fi } minsize() { @@ -364,6 +408,8 @@ minsize() { shift runtests "$release" "$_minsize_CC" "-Os" "$_minsize_run_tests" + + runlibtests "$release" "$_minsize_CC" "-Os" "$_minsize_run_tests" } build_set() { diff --git a/contrib/bc/src/args.c b/contrib/bc/src/args.c index 029237627786..4c9ad3b95549 100644 --- a/contrib/bc/src/args.c +++ b/contrib/bc/src/args.c @@ -41,10 +41,8 @@ #include <unistd.h> -#include <status.h> #include <vector.h> #include <read.h> -#include <vm.h> #include <args.h> #include <opt.h> @@ -109,7 +107,7 @@ void bc_args(int argc, char *argv[]) { case 'e': { if (vm.no_exit_exprs) - bc_vm_verr(BC_ERROR_FATAL_OPTION, "-e (--expression)"); + bc_vm_verr(BC_ERR_FATAL_OPTION, "-e (--expression)"); bc_args_exprs(opts.optarg); break; } @@ -119,7 +117,7 @@ void bc_args(int argc, char *argv[]) { if (!strcmp(opts.optarg, "-")) vm.no_exit_exprs = true; else { if (vm.no_exit_exprs) - bc_vm_verr(BC_ERROR_FATAL_OPTION, "-f (--file)"); + bc_vm_verr(BC_ERR_FATAL_OPTION, "-f (--file)"); bc_args_file(opts.optarg); } break; diff --git a/contrib/bc/src/bc/bc.c b/contrib/bc/src/bc.c index 3d488b5640c8..cdf3cc9c3a28 100644 --- a/contrib/bc/src/bc/bc.c +++ b/contrib/bc/src/bc.c @@ -37,7 +37,6 @@ #include <string.h> -#include <status.h> #include <bc.h> #include <vm.h> diff --git a/contrib/bc/src/bc/lex.c b/contrib/bc/src/bc_lex.c index cc780e0d6278..87475385fe70 100644 --- a/contrib/bc/src/bc/lex.c +++ b/contrib/bc/src/bc_lex.c @@ -39,7 +39,6 @@ #include <ctype.h> #include <string.h> -#include <lex.h> #include <bc.h> #include <vm.h> @@ -58,7 +57,7 @@ static void bc_lex_identifier(BcLex *l) { l->t = BC_LEX_KW_AUTO + (BcLexType) i; if (!BC_LEX_KW_POSIX(kw)) - bc_lex_verr(l, BC_ERROR_POSIX_KW, kw->name); + bc_lex_verr(l, BC_ERR_POSIX_KW, kw->name); // We minus 1 because the index has already been incremented. l->i += n - 1; @@ -69,7 +68,7 @@ static void bc_lex_identifier(BcLex *l) { bc_lex_name(l); if (BC_ERR(l->str.len - 1 > 1)) - bc_lex_verr(l, BC_ERROR_POSIX_NAME_LEN, l->str.v); + bc_lex_verr(l, BC_ERR_POSIX_NAME_LEN, l->str.v); } static void bc_lex_string(BcLex *l) { @@ -84,7 +83,7 @@ static void bc_lex_string(BcLex *l) { if (BC_ERR(c == '\0')) { l->i = i; - bc_lex_err(l, BC_ERROR_PARSE_STRING); + bc_lex_err(l, BC_ERR_PARSE_STRING); } len = i - l->i; @@ -126,7 +125,7 @@ void bc_lex_token(BcLex *l) { bc_lex_assign(l, BC_LEX_OP_REL_NE, BC_LEX_OP_BOOL_NOT); if (l->t == BC_LEX_OP_BOOL_NOT) - bc_lex_verr(l, BC_ERROR_POSIX_BOOL, "!"); + bc_lex_verr(l, BC_ERR_POSIX_BOOL, "!"); break; } @@ -139,7 +138,7 @@ void bc_lex_token(BcLex *l) { case '#': { - bc_lex_err(l, BC_ERROR_POSIX_COMMENT); + bc_lex_err(l, BC_ERR_POSIX_COMMENT); bc_lex_lineComment(l); break; } @@ -155,7 +154,7 @@ void bc_lex_token(BcLex *l) { c2 = l->buf[l->i]; if (BC_NO_ERR(c2 == '&')) { - bc_lex_verr(l, BC_ERROR_POSIX_BOOL, "&&"); + bc_lex_verr(l, BC_ERR_POSIX_BOOL, "&&"); l->i += 1; l->t = BC_LEX_OP_BOOL_AND; @@ -224,7 +223,7 @@ void bc_lex_token(BcLex *l) { if (BC_LEX_NUM_CHAR(c2, true, false)) bc_lex_number(l, c); else { l->t = BC_LEX_KW_LAST; - bc_lex_err(l, BC_ERROR_POSIX_DOT); + bc_lex_err(l, BC_ERR_POSIX_DOT); } break; } @@ -391,7 +390,7 @@ void bc_lex_token(BcLex *l) { if (BC_NO_ERR(c2 == '|')) { - bc_lex_verr(l, BC_ERROR_POSIX_BOOL, "||"); + bc_lex_verr(l, BC_ERR_POSIX_BOOL, "||"); l->i += 1; l->t = BC_LEX_OP_BOOL_OR; diff --git a/contrib/bc/src/bc/parse.c b/contrib/bc/src/bc_parse.c index 329c1a84b419..35d3e45c581c 100644 --- a/contrib/bc/src/bc/parse.c +++ b/contrib/bc/src/bc_parse.c @@ -42,8 +42,6 @@ #include <setjmp.h> -#include <lex.h> -#include <parse.h> #include <bc.h> #include <num.h> #include <vm.h> @@ -190,7 +188,7 @@ static void bc_parse_params(BcParse *p, uint8_t flags) { if (comma) bc_lex_next(&p->l); } - if (BC_ERR(comma)) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (BC_ERR(comma)) bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_parse_push(p, BC_INST_CALL); bc_parse_pushIndex(p, nparams); } @@ -251,7 +249,7 @@ static void bc_parse_name(BcParse *p, BcInst *type, if (p->l.t == BC_LEX_RBRACKET) { if (BC_ERR(!(flags & BC_PARSE_ARRAY))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); *type = BC_INST_ARRAY; *can_assign = false; @@ -264,7 +262,7 @@ static void bc_parse_name(BcParse *p, BcInst *type, bc_parse_expr_status(p, flags2, bc_parse_next_elem); if (BC_ERR(p->l.t != BC_LEX_RBRACKET)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); *type = BC_INST_ARRAY_ELEM; *can_assign = true; @@ -278,7 +276,7 @@ static void bc_parse_name(BcParse *p, BcInst *type, else if (p->l.t == BC_LEX_LPAREN) { if (BC_ERR(flags & BC_PARSE_NOCALL)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); *type = BC_INST_CALL; *can_assign = false; @@ -301,10 +299,10 @@ err: static void bc_parse_noArgBuiltin(BcParse *p, BcInst inst) { bc_lex_next(&p->l); - if (BC_ERR(p->l.t != BC_LEX_LPAREN)) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (BC_ERR(p->l.t != BC_LEX_LPAREN)) bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_lex_next(&p->l); - if ((p->l.t != BC_LEX_RPAREN)) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if ((p->l.t != BC_LEX_RPAREN)) bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_parse_push(p, inst); @@ -316,7 +314,7 @@ static void bc_parse_builtin(BcParse *p, BcLexType type, { bc_lex_next(&p->l); if (BC_ERR(p->l.t != BC_LEX_LPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_lex_next(&p->l); @@ -327,7 +325,7 @@ static void bc_parse_builtin(BcParse *p, BcLexType type, bc_parse_expr_status(p, flags, bc_parse_next_rel); if (BC_ERR(p->l.t != BC_LEX_RPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); *prev = type - BC_LEX_KW_LENGTH + BC_INST_LENGTH; bc_parse_push(p, *prev); @@ -356,7 +354,7 @@ static void bc_parse_scale(BcParse *p, BcInst *type, bc_parse_expr_status(p, flags, bc_parse_next_rel); if (BC_ERR(p->l.t != BC_LEX_RPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_parse_push(p, BC_INST_SCALE_FUNC); @@ -376,12 +374,12 @@ static void bc_parse_incdec(BcParse *p, BcInst *prev, bool *can_assign, if (BC_ERR(last == BC_LEX_OP_INC || last == BC_LEX_OP_DEC || last == BC_LEX_RPAREN)) { - bc_parse_err(p, BC_ERROR_PARSE_ASSIGN); + bc_parse_err(p, BC_ERR_PARSE_ASSIGN); } if (BC_PARSE_INST_VAR(etype)) { - if (!*can_assign) bc_parse_err(p, BC_ERROR_PARSE_ASSIGN); + if (!*can_assign) bc_parse_err(p, BC_ERR_PARSE_ASSIGN); *prev = inst = BC_INST_INC + (p->l.t != BC_LEX_OP_INC); bc_parse_push(p, inst); @@ -412,10 +410,10 @@ static void bc_parse_incdec(BcParse *p, BcInst *prev, bool *can_assign, bc_lex_next(&p->l); if (BC_ERR(p->l.t == BC_LEX_LPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); else bc_parse_push(p, BC_INST_SCALE); } - else bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + else bc_parse_err(p, BC_ERR_PARSE_TOKEN); *can_assign = false; @@ -455,7 +453,7 @@ static void bc_parse_print(BcParse *p) { t = p->l.t; - if (bc_parse_isDelimiter(p)) bc_parse_err(p, BC_ERROR_PARSE_PRINT); + if (bc_parse_isDelimiter(p)) bc_parse_err(p, BC_ERR_PARSE_PRINT); do { if (t == BC_LEX_STR) bc_parse_str(p, BC_INST_PRINT_POP); @@ -469,14 +467,14 @@ static void bc_parse_print(BcParse *p) { if (comma) bc_lex_next(&p->l); else { if (!bc_parse_isDelimiter(p)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); else break; } t = p->l.t; } while (true); - if (BC_ERR(comma)) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (BC_ERR(comma)) bc_parse_err(p, BC_ERR_PARSE_TOKEN); } static void bc_parse_return(BcParse *p) { @@ -485,7 +483,7 @@ static void bc_parse_return(BcParse *p) { bool paren; uchar inst = BC_INST_RET0; - if (BC_ERR(!BC_PARSE_FUNC(p))) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (BC_ERR(!BC_PARSE_FUNC(p))) bc_parse_err(p, BC_ERR_PARSE_TOKEN); if (p->func->voidfn) inst = BC_INST_RET_VOID; @@ -507,10 +505,10 @@ static void bc_parse_return(BcParse *p) { } if (!paren || p->l.last != BC_LEX_RPAREN) { - bc_parse_err(p, BC_ERROR_POSIX_RET); + bc_parse_err(p, BC_ERR_POSIX_RET); } else if (BC_ERR(p->func->voidfn)) - bc_parse_verr(p, BC_ERROR_PARSE_RET_VOID, p->func->name); + bc_parse_verr(p, BC_ERR_PARSE_RET_VOID, p->func->name); bc_parse_push(p, BC_INST_RET); } @@ -526,7 +524,7 @@ static void bc_parse_endBody(BcParse *p, bool brace) { bool has_brace, new_else = false; - if (BC_ERR(p->flags.len <= 1)) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (BC_ERR(p->flags.len <= 1)) bc_parse_err(p, BC_ERR_PARSE_TOKEN); if (brace) { @@ -534,7 +532,7 @@ static void bc_parse_endBody(BcParse *p, bool brace) { bc_lex_next(&p->l); if (BC_ERR(!bc_parse_isDelimiter(p))) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); } has_brace = (BC_PARSE_BRACE(p) != 0); @@ -543,7 +541,7 @@ static void bc_parse_endBody(BcParse *p, bool brace) { size_t len = p->flags.len; bool loop; - if (has_brace && !brace) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (has_brace && !brace) bc_parse_err(p, BC_ERR_PARSE_TOKEN); loop = (BC_PARSE_LOOP_INNER(p) != 0); @@ -595,7 +593,7 @@ static void bc_parse_endBody(BcParse *p, bool brace) { !(has_brace = (BC_PARSE_BRACE(p) != 0))); if (BC_ERR(p->flags.len == 1 && brace)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); else if (brace && BC_PARSE_BRACE(p)) { uint16_t flags = BC_PARSE_TOP_FLAG(p); @@ -623,12 +621,12 @@ static void bc_parse_if(BcParse *p) { bc_lex_next(&p->l); if (BC_ERR(p->l.t != BC_LEX_LPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_lex_next(&p->l); bc_parse_expr_status(p, flags, bc_parse_next_rel); if (BC_ERR(p->l.t != BC_LEX_RPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_lex_next(&p->l); bc_parse_push(p, BC_INST_JUMP_ZERO); @@ -645,7 +643,7 @@ static void bc_parse_else(BcParse *p) { size_t idx = p->func->labels.len; if (BC_ERR(!BC_PARSE_IF_END(p))) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_parse_push(p, BC_INST_JUMP); bc_parse_pushIndex(p, idx); @@ -665,7 +663,7 @@ static void bc_parse_while(BcParse *p) { bc_lex_next(&p->l); if (BC_ERR(p->l.t != BC_LEX_LPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_lex_next(&p->l); bc_parse_createCondLabel(p, p->func->labels.len); @@ -674,7 +672,7 @@ static void bc_parse_while(BcParse *p) { bc_parse_expr_status(p, flags, bc_parse_next_rel); if (BC_ERR(p->l.t != BC_LEX_RPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_lex_next(&p->l); bc_parse_push(p, BC_INST_JUMP_ZERO); @@ -688,15 +686,15 @@ static void bc_parse_for(BcParse *p) { bc_lex_next(&p->l); if (BC_ERR(p->l.t != BC_LEX_LPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_lex_next(&p->l); if (p->l.t != BC_LEX_SCOLON) bc_parse_expr_status(p, 0, bc_parse_next_for); - else bc_parse_err(p, BC_ERROR_POSIX_FOR); + else bc_parse_err(p, BC_ERR_POSIX_FOR); if (BC_ERR(p->l.t != BC_LEX_SCOLON)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_lex_next(&p->l); cond_idx = p->func->labels.len; @@ -715,14 +713,14 @@ static void bc_parse_for(BcParse *p) { // Set this for the next call to bc_parse_number. // This is safe to set because the current token // is a semicolon, which has no string requirement. - bc_vec_string(&p->l.str, strlen(bc_parse_const1), bc_parse_const1); + bc_vec_string(&p->l.str, sizeof(bc_parse_one) - 1, bc_parse_one); bc_parse_number(p); - bc_parse_err(p, BC_ERROR_POSIX_FOR); + bc_parse_err(p, BC_ERR_POSIX_FOR); } if (BC_ERR(p->l.t != BC_LEX_SCOLON)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_lex_next(&p->l); @@ -735,10 +733,10 @@ static void bc_parse_for(BcParse *p) { if (p->l.t != BC_LEX_RPAREN) bc_parse_expr_status(p, 0, bc_parse_next_rel); - else bc_parse_err(p, BC_ERROR_POSIX_FOR); + else bc_parse_err(p, BC_ERR_POSIX_FOR); if (BC_ERR(p->l.t != BC_LEX_RPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_parse_push(p, BC_INST_JUMP); bc_parse_pushIndex(p, cond_idx); bc_parse_createLabel(p, p->func->code.len); @@ -753,11 +751,11 @@ static void bc_parse_loopExit(BcParse *p, BcLexType type) { size_t i; BcInstPtr *ip; - if (BC_ERR(!BC_PARSE_LOOP(p))) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (BC_ERR(!BC_PARSE_LOOP(p))) bc_parse_err(p, BC_ERR_PARSE_TOKEN); if (type == BC_LEX_KW_BREAK) { - if (BC_ERR(!p->exits.len)) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (BC_ERR(!p->exits.len)) bc_parse_err(p, BC_ERR_PARSE_TOKEN); i = p->exits.len - 1; ip = bc_vec_item(&p->exits, i); @@ -783,7 +781,7 @@ static void bc_parse_func(BcParse *p) { bc_lex_next(&p->l); if (BC_ERR(p->l.t != BC_LEX_NAME)) - bc_parse_err(p, BC_ERROR_PARSE_FUNC); + bc_parse_err(p, BC_ERR_PARSE_FUNC); voidfn = (!BC_IS_POSIX && p->l.t == BC_LEX_NAME && !strcmp(p->l.str.v, "void")); @@ -793,12 +791,12 @@ static void bc_parse_func(BcParse *p) { voidfn = (voidfn && p->l.t == BC_LEX_NAME); if (voidfn) { - bc_parse_err(p, BC_ERROR_POSIX_VOID); + bc_parse_err(p, BC_ERR_POSIX_VOID); bc_lex_next(&p->l); } if (BC_ERR(p->l.t != BC_LEX_LPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_FUNC); + bc_parse_err(p, BC_ERR_PARSE_FUNC); assert(p->prog->fns.len == p->prog->fn_map.len); @@ -821,11 +819,11 @@ static void bc_parse_func(BcParse *p) { if (p->l.t == BC_LEX_OP_MULTIPLY) { t = BC_TYPE_REF; bc_lex_next(&p->l); - bc_parse_err(p, BC_ERROR_POSIX_REF); + bc_parse_err(p, BC_ERR_POSIX_REF); } if (BC_ERR(p->l.t != BC_LEX_NAME)) - bc_parse_err(p, BC_ERROR_PARSE_FUNC); + bc_parse_err(p, BC_ERR_PARSE_FUNC); p->func->nparams += 1; @@ -840,12 +838,12 @@ static void bc_parse_func(BcParse *p) { bc_lex_next(&p->l); if (BC_ERR(p->l.t != BC_LEX_RBRACKET)) - bc_parse_err(p, BC_ERROR_PARSE_FUNC); + bc_parse_err(p, BC_ERR_PARSE_FUNC); bc_lex_next(&p->l); } else if (BC_ERR(t == BC_TYPE_REF)) - bc_parse_verr(p, BC_ERROR_PARSE_REF_VAR, p->buf.v); + bc_parse_verr(p, BC_ERR_PARSE_REF_VAR, p->buf.v); comma = (p->l.t == BC_LEX_COMMA); if (comma) { @@ -855,21 +853,21 @@ static void bc_parse_func(BcParse *p) { bc_func_insert(p->func, p->prog, p->buf.v, t, p->l.line); } - if (BC_ERR(comma)) bc_parse_err(p, BC_ERROR_PARSE_FUNC); + if (BC_ERR(comma)) bc_parse_err(p, BC_ERR_PARSE_FUNC); flags = BC_PARSE_FLAG_FUNC | BC_PARSE_FLAG_FUNC_INNER; bc_parse_startBody(p, flags); bc_lex_next(&p->l); - if (p->l.t != BC_LEX_LBRACE) bc_parse_err(p, BC_ERROR_POSIX_BRACE); + if (p->l.t != BC_LEX_LBRACE) bc_parse_err(p, BC_ERR_POSIX_BRACE); } static void bc_parse_auto(BcParse *p) { bool comma, one; - if (BC_ERR(!p->auto_part)) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (BC_ERR(!p->auto_part)) bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_lex_next(&p->l); p->auto_part = comma = false; @@ -890,7 +888,7 @@ static void bc_parse_auto(BcParse *p) { bc_lex_next(&p->l); if (BC_ERR(p->l.t != BC_LEX_RBRACKET)) - bc_parse_err(p, BC_ERROR_PARSE_FUNC); + bc_parse_err(p, BC_ERR_PARSE_FUNC); bc_lex_next(&p->l); } @@ -902,10 +900,10 @@ static void bc_parse_auto(BcParse *p) { bc_func_insert(p->func, p->prog, p->buf.v, t, p->l.line); } - if (BC_ERR(comma)) bc_parse_err(p, BC_ERROR_PARSE_FUNC); - if (BC_ERR(!one)) bc_parse_err(p, BC_ERROR_PARSE_NO_AUTO); + if (BC_ERR(comma)) bc_parse_err(p, BC_ERR_PARSE_FUNC); + if (BC_ERR(!one)) bc_parse_err(p, BC_ERR_PARSE_NO_AUTO); if (BC_ERR(!bc_parse_isDelimiter(p))) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); } static void bc_parse_body(BcParse *p, bool brace) { @@ -919,7 +917,7 @@ static void bc_parse_body(BcParse *p, bool brace) { if (*flag_ptr & BC_PARSE_FLAG_FUNC_INNER) { - if (BC_ERR(!brace)) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (BC_ERR(!brace)) bc_parse_err(p, BC_ERR_PARSE_TOKEN); p->auto_part = (p->l.t != BC_LEX_KW_AUTO); @@ -1134,13 +1132,13 @@ static void bc_parse_stmt(BcParse *p) { default: { - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); } } if (len == p->flags.len && flags == BC_PARSE_TOP_FLAG(p)) { if (BC_ERR(!bc_parse_isDelimiter(p))) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); } // Make sure semicolons are eaten. @@ -1153,10 +1151,10 @@ void bc_parse_parse(BcParse *p) { BC_SETJMP(exit); - if (BC_ERR(p->l.t == BC_LEX_EOF)) bc_parse_err(p, BC_ERROR_PARSE_EOF); + if (BC_ERR(p->l.t == BC_LEX_EOF)) bc_parse_err(p, BC_ERR_PARSE_EOF); else if (p->l.t == BC_LEX_KW_DEFINE) { if (BC_ERR(BC_PARSE_NO_EXEC(p))) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_parse_func(p); } else bc_parse_stmt(p); @@ -1198,7 +1196,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, case BC_LEX_OP_INC: case BC_LEX_OP_DEC: { - if (BC_ERR(incdec)) bc_parse_err(p, BC_ERROR_PARSE_ASSIGN); + if (BC_ERR(incdec)) bc_parse_err(p, BC_ERR_PARSE_ASSIGN); bc_parse_incdec(p, &prev, &can_assign, &nexprs, flags); rprn = get_token = bin_last = false; incdec = true; @@ -1210,7 +1208,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, case BC_LEX_OP_TRUNC: { if (BC_ERR(!BC_PARSE_LEAF(prev, bin_last, rprn))) - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); // I can just add the instruction because // negative will already be taken care of. @@ -1246,9 +1244,11 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, case BC_LEX_OP_ASSIGN: { if (!BC_PARSE_INST_VAR(prev)) - bc_parse_err(p, BC_ERROR_PARSE_ASSIGN); + bc_parse_err(p, BC_ERR_PARSE_ASSIGN); } // Fallthrough. + BC_FALLTHROUGH + case BC_LEX_OP_POWER: case BC_LEX_OP_MULTIPLY: case BC_LEX_OP_DIVIDE: @@ -1271,10 +1271,10 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, { if (BC_PARSE_OP_PREFIX(t)) { if (BC_ERR(!bin_last && !BC_PARSE_OP_PREFIX(p->l.last))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); } else if (BC_ERR(BC_PARSE_PREV_PREFIX(prev) || bin_last)) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); nrelops += (t >= BC_LEX_OP_REL_EQ && t <= BC_LEX_OP_REL_GT); prev = BC_PARSE_TOKEN_INST(t); @@ -1290,7 +1290,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, case BC_LEX_LPAREN: { if (BC_ERR(BC_PARSE_LEAF(prev, bin_last, rprn))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); nparens += 1; rprn = incdec = can_assign = false; @@ -1308,7 +1308,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, return BC_PARSE_STATUS_EMPTY_EXPR; if (BC_ERR(bin_last || BC_PARSE_PREV_PREFIX(prev))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); if (!nparens) { done = true; @@ -1328,7 +1328,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, case BC_LEX_NAME: { if (BC_ERR(BC_PARSE_LEAF(prev, bin_last, rprn))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); get_token = bin_last = false; bc_parse_name(p, &prev, &can_assign, @@ -1343,7 +1343,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, case BC_LEX_NUMBER: { if (BC_ERR(BC_PARSE_LEAF(prev, bin_last, rprn))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); bc_parse_number(p); nexprs += 1; @@ -1363,7 +1363,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, #endif // BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND { if (BC_ERR(BC_PARSE_LEAF(prev, bin_last, rprn))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); prev = t - BC_LEX_KW_LAST + BC_INST_LAST; bc_parse_push(p, prev); @@ -1384,7 +1384,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, #endif // BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND { if (BC_ERR(BC_PARSE_LEAF(prev, bin_last, rprn))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); bc_parse_builtin(p, t, flags, &prev); rprn = get_token = bin_last = incdec = can_assign = false; @@ -1406,9 +1406,9 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, #endif // BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND { if (BC_ERR(BC_PARSE_LEAF(prev, bin_last, rprn))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); else if (t == BC_LEX_KW_READ && BC_ERR(flags & BC_PARSE_NOREAD)) - bc_parse_err(p, BC_ERROR_EXEC_REC_READ); + bc_parse_err(p, BC_ERR_EXEC_REC_READ); else { prev = t - BC_LEX_KW_READ + BC_INST_READ; bc_parse_noArgBuiltin(p, prev); @@ -1424,7 +1424,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, case BC_LEX_KW_SCALE: { if (BC_ERR(BC_PARSE_LEAF(prev, bin_last, rprn))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); bc_parse_scale(p, &prev, &can_assign, flags); rprn = get_token = bin_last = false; @@ -1437,7 +1437,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, default: { #ifndef NDEBUG - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); break; #endif // NDEBUG } @@ -1452,7 +1452,7 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, assign = top >= BC_LEX_OP_ASSIGN_POWER && top <= BC_LEX_OP_ASSIGN; if (BC_ERR(top == BC_LEX_LPAREN || top == BC_LEX_RPAREN)) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); bc_parse_push(p, BC_PARSE_TOKEN_INST(top)); @@ -1462,16 +1462,16 @@ static BcParseStatus bc_parse_expr_err(BcParse *p, uint8_t flags, incdec = false; } - if (BC_ERR(nexprs != 1)) bc_parse_err(p, BC_ERROR_PARSE_EXPR); + if (BC_ERR(nexprs != 1)) bc_parse_err(p, BC_ERR_PARSE_EXPR); for (i = 0; i < next.len && t != next.tokens[i]; ++i); if (BC_ERR(i == next.len && !bc_parse_isDelimiter(p))) - bc_parse_err(p, BC_ERROR_PARSE_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EXPR); if (!(flags & BC_PARSE_REL) && nrelops) - bc_parse_err(p, BC_ERROR_POSIX_REL_POS); + bc_parse_err(p, BC_ERR_POSIX_REL_POS); else if ((flags & BC_PARSE_REL) && nrelops > 1) - bc_parse_err(p, BC_ERROR_POSIX_MULTIREL); + bc_parse_err(p, BC_ERR_POSIX_MULTIREL); if (!(flags & BC_PARSE_NEEDVAL) && !pfirst) { @@ -1522,7 +1522,7 @@ void bc_parse_expr_status(BcParse *p, uint8_t flags, BcParseNext next) { BcParseStatus s = bc_parse_expr_err(p, flags, next); if (BC_ERR(s == BC_PARSE_STATUS_EMPTY_EXPR)) - bc_parse_err(p, BC_ERROR_PARSE_EMPTY_EXPR); + bc_parse_err(p, BC_ERR_PARSE_EMPTY_EXPR); } void bc_parse_expr(BcParse *p, uint8_t flags) { diff --git a/contrib/bc/src/data.c b/contrib/bc/src/data.c index 039c83e1cac1..a3cf4dbda293 100644 --- a/contrib/bc/src/data.c +++ b/contrib/bc/src/data.c @@ -43,6 +43,8 @@ #include <program.h> #include <vm.h> +#if !BC_ENABLE_LIBRARY + #if BC_ENABLED const char bc_sig_msg[] = "\ninterrupt (type \"quit\" to exit)\n"; const uchar bc_sig_msg_len = (uchar) (sizeof(bc_sig_msg) - 1); @@ -664,11 +666,8 @@ const char* bc_inst_names[] = { }; #endif // BC_DEBUG_CODE -#if BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND - -const BcRandState bc_rand_multiplier = BC_RAND_MULTIPLIER; - -#endif // BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND +const char bc_parse_zero[2] = "0"; +const char bc_parse_one[2] = "1"; #if BC_ENABLED const BcLexKeyword bc_lex_kws[] = { @@ -712,8 +711,6 @@ const BcLexKeyword bc_lex_kws[] = { const size_t bc_lex_kws_len = sizeof(bc_lex_kws) / sizeof(BcLexKeyword); -const char* const bc_parse_const1 = "1"; - // This is an array that corresponds to token types. An entry is // true if the token is valid in an expression, false otherwise. const uint8_t bc_parse_exprs[] = { @@ -937,11 +934,26 @@ const uchar dc_parse_insts[] = { }; #endif // DC_ENABLED +#endif // !BC_ENABLE_LIBRARY + +#if BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND + +const BcRandState bc_rand_multiplier = BC_RAND_MULTIPLIER; + +#endif // BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND + #if BC_LONG_BIT >= 64 const BcDig bc_num_bigdigMax[] = { 709551616U, 446744073U, - 18U + 18U, +}; +const BcDig bc_num_bigdigMax2[] = { + 768211456U, + 374607431U, + 938463463U, + 282366920U, + 340U, }; #else // BC_LONG_BIT >= 64 const BcDig bc_num_bigdigMax[] = { @@ -949,12 +961,17 @@ const BcDig bc_num_bigdigMax[] = { 9496U, 42U, }; +const BcDig bc_num_bigdigMax2[] = { + 1616U, + 955U, + 737U, + 6744U, + 1844U, +}; #endif // BC_LONG_BIT >= 64 const size_t bc_num_bigdigMax_size = sizeof(bc_num_bigdigMax) / sizeof(BcDig); - -const char bc_parse_zero[] = "0"; -const char bc_parse_one[] = "1"; +const size_t bc_num_bigdigMax2_size = sizeof(bc_num_bigdigMax2) / sizeof(BcDig); const char bc_num_hex_digits[] = "0123456789ABCDEF"; @@ -973,6 +990,8 @@ const BcBigDig bc_num_pow10[BC_BASE_DIGS + 1] = { #endif // BC_BASE_DIGS > 4 }; +#if !BC_ENABLE_LIBRARY + const BcNumBinaryOp bc_program_ops[] = { bc_num_pow, bc_num_mul, bc_num_div, bc_num_mod, bc_num_add, bc_num_sub, #if BC_ENABLE_EXTRA_MATH @@ -981,7 +1000,7 @@ const BcNumBinaryOp bc_program_ops[] = { }; const BcNumBinaryOpReq bc_program_opReqs[] = { - bc_num_powReq, bc_num_mulReq, bc_num_mulReq, bc_num_mulReq, + bc_num_powReq, bc_num_mulReq, bc_num_divReq, bc_num_divReq, bc_num_addReq, bc_num_addReq, #if BC_ENABLE_EXTRA_MATH bc_num_placesReq, bc_num_placesReq, bc_num_placesReq, @@ -1002,3 +1021,5 @@ const char bc_program_ready_msg[] = "ready for more input\n"; const size_t bc_program_ready_msg_len = sizeof(bc_program_ready_msg) - 1; const char bc_program_esc_chars[] = "ab\\efnqrt"; const char bc_program_esc_seqs[] = "\a\b\\\\\f\n\"\r\t"; + +#endif // !BC_ENABLE_LIBRARY diff --git a/contrib/bc/src/dc/dc.c b/contrib/bc/src/dc.c index 8c03ccf0e414..41c49a08b367 100644 --- a/contrib/bc/src/dc/dc.c +++ b/contrib/bc/src/dc.c @@ -37,7 +37,6 @@ #include <string.h> -#include <status.h> #include <dc.h> #include <vm.h> diff --git a/contrib/bc/src/dc/lex.c b/contrib/bc/src/dc_lex.c index b17f01bc990d..e9a7d2ca1e4b 100644 --- a/contrib/bc/src/dc/lex.c +++ b/contrib/bc/src/dc_lex.c @@ -37,8 +37,6 @@ #include <ctype.h> -#include <status.h> -#include <lex.h> #include <dc.h> #include <vm.h> @@ -57,7 +55,7 @@ static void dc_lex_register(BcLex *l) { c = l->buf[l->i]; if (!isalnum(c) && c != '_') - bc_lex_verr(l, BC_ERROR_PARSE_CHAR, c); + bc_lex_verr(l, BC_ERR_PARSE_CHAR, c); l->i += 1; bc_lex_name(l); @@ -96,7 +94,7 @@ static void dc_lex_string(BcLex *l) { if (BC_ERR(c == '\0' && depth)) { l->i = i; - bc_lex_err(l, BC_ERROR_PARSE_STRING); + bc_lex_err(l, BC_ERR_PARSE_STRING); } bc_vec_pushByte(&l->str, '\0'); diff --git a/contrib/bc/src/dc/parse.c b/contrib/bc/src/dc_parse.c index 86edc5f66505..81191541fa83 100644 --- a/contrib/bc/src/dc/parse.c +++ b/contrib/bc/src/dc_parse.c @@ -40,8 +40,6 @@ #include <string.h> #include <setjmp.h> -#include <status.h> -#include <parse.h> #include <dc.h> #include <program.h> #include <vm.h> @@ -49,7 +47,7 @@ static void dc_parse_register(BcParse *p, bool var) { bc_lex_next(&p->l); - if (p->l.t != BC_LEX_NAME) bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + if (p->l.t != BC_LEX_NAME) bc_parse_err(p, BC_ERR_PARSE_TOKEN); bc_parse_pushName(p, p->l.str.v, var); } @@ -132,6 +130,8 @@ static void dc_parse_token(BcParse *p, BcLexType t, uint8_t flags) { bc_lex_next(&p->l); } // Fallthrough. + BC_FALLTHROUGH + case BC_LEX_NUMBER: { bc_parse_number(p); @@ -145,7 +145,7 @@ static void dc_parse_token(BcParse *p, BcLexType t, uint8_t flags) { case BC_LEX_KW_READ: { if (BC_ERR(flags & BC_PARSE_NOREAD)) - bc_parse_err(p, BC_ERROR_EXEC_REC_READ); + bc_parse_err(p, BC_ERR_EXEC_REC_READ); else bc_parse_push(p, BC_INST_READ); get_token = true; break; @@ -182,7 +182,7 @@ static void dc_parse_token(BcParse *p, BcLexType t, uint8_t flags) { default: { - bc_parse_err(p, BC_ERROR_PARSE_TOKEN); + bc_parse_err(p, BC_ERR_PARSE_TOKEN); } } @@ -214,7 +214,7 @@ void dc_parse_expr(BcParse *p, uint8_t flags) { } if (BC_ERR(need_expr && !have_expr)) - bc_vm_err(BC_ERROR_EXEC_READ_EXPR); + bc_vm_err(BC_ERR_EXEC_READ_EXPR); else if (p->l.t == BC_LEX_EOF && (flags & BC_PARSE_NOCALL)) bc_parse_push(p, BC_INST_POP_EXEC); } @@ -225,7 +225,7 @@ void dc_parse_parse(BcParse *p) { BC_SETJMP(exit); - if (BC_ERR(p->l.t == BC_LEX_EOF)) bc_parse_err(p, BC_ERROR_PARSE_EOF); + if (BC_ERR(p->l.t == BC_LEX_EOF)) bc_parse_err(p, BC_ERR_PARSE_EOF); else dc_parse_expr(p, 0); exit: diff --git a/contrib/bc/src/file.c b/contrib/bc/src/file.c index 01997399f452..1d4d390f89a4 100644 --- a/contrib/bc/src/file.c +++ b/contrib/bc/src/file.c @@ -41,8 +41,8 @@ #include <file.h> #include <vm.h> -void bc_file_ultoa(unsigned long long val, char buf[BC_FILE_ULL_LENGTH]) { - +static void bc_file_ultoa(unsigned long long val, char buf[BC_FILE_ULL_LENGTH]) +{ char buf2[BC_FILE_ULL_LENGTH]; size_t i, len; @@ -105,7 +105,7 @@ void bc_file_flush(BcFile *restrict f) { vm.status = (sig_atomic_t) s; BC_VM_JMP; } - else bc_vm_err(BC_ERROR_FATAL_IO_ERR); + else bc_vm_err(BC_ERR_FATAL_IO_ERR); } } diff --git a/contrib/bc/src/history/history.c b/contrib/bc/src/history.c index b94fbb7b3fdf..ae4b42d326c0 100644 --- a/contrib/bc/src/history/history.c +++ b/contrib/bc/src/history.c @@ -383,7 +383,7 @@ static BcStatus bc_history_readCode(char *buf, size_t buf_len, return BC_STATUS_SUCCESS; err: - if (BC_ERR(n < 0)) bc_vm_err(BC_ERROR_FATAL_IO_ERR); + if (BC_ERR(n < 0)) bc_vm_err(BC_ERR_FATAL_IO_ERR); else *nread = (size_t) n; return BC_STATUS_EOF; } @@ -441,7 +441,7 @@ static void bc_history_enableRaw(BcHistory *h) { BC_SIG_LOCK; if (BC_ERR(tcgetattr(STDIN_FILENO, &h->orig_termios) == -1)) - bc_vm_err(BC_ERROR_FATAL_IO_ERR); + bc_vm_err(BC_ERR_FATAL_IO_ERR); BC_SIG_UNLOCK; @@ -473,7 +473,7 @@ static void bc_history_enableRaw(BcHistory *h) { BC_SIG_UNLOCK; - if (BC_ERR(err < 0)) bc_vm_err(BC_ERROR_FATAL_IO_ERR); + if (BC_ERR(err < 0)) bc_vm_err(BC_ERR_FATAL_IO_ERR); h->rawMode = true; } @@ -672,7 +672,7 @@ static void bc_history_refresh(BcHistory *h) { */ static void bc_history_edit_insert(BcHistory *h, const char *cbuf, size_t clen) { - bc_vec_expand(&h->buf, bc_vm_growSize(h->buf.len, clen)); + bc_vec_grow(&h->buf, clen); if (h->pos == BC_HIST_BUF_LEN(h)) { @@ -948,8 +948,7 @@ static void bc_history_escape(BcHistory *h) { } else { - if (BC_ERR(BC_HIST_READ(seq + 1, 1))) - bc_vm_err(BC_ERROR_FATAL_IO_ERR); + if (BC_ERR(BC_HIST_READ(seq + 1, 1))) bc_vm_err(BC_ERR_FATAL_IO_ERR); // ESC [ sequences. if (c == '[') { @@ -960,13 +959,13 @@ static void bc_history_escape(BcHistory *h) { // Extended escape, read additional byte. if (BC_ERR(BC_HIST_READ(seq + 2, 1))) - bc_vm_err(BC_ERROR_FATAL_IO_ERR); + bc_vm_err(BC_ERR_FATAL_IO_ERR); if (seq[2] == '~' && c == '3') bc_history_edit_delete(h); else if(seq[2] == ';') { if (BC_ERR(BC_HIST_READ(seq, 2))) - bc_vm_err(BC_ERROR_FATAL_IO_ERR); + bc_vm_err(BC_ERR_FATAL_IO_ERR); if (seq[0] != '5') return; else if (seq[1] == 'C') bc_history_edit_wordEnd(h); diff --git a/contrib/bc/src/lang.c b/contrib/bc/src/lang.c index bd287c75ee78..bc34e7c269f8 100644 --- a/contrib/bc/src/lang.c +++ b/contrib/bc/src/lang.c @@ -77,7 +77,7 @@ void bc_func_insert(BcFunc *f, BcProgram *p, char *name, BcLoc *id = bc_vec_item(&f->autos, i); if (BC_ERR(idx == id->loc && type == (BcType) id->idx)) { const char *array = type == BC_TYPE_ARRAY ? "[]" : ""; - bc_vm_error(BC_ERROR_PARSE_DUP_LOCAL, line, name, array); + bc_vm_error(BC_ERR_PARSE_DUP_LOCAL, line, name, array); } } diff --git a/contrib/bc/src/lex.c b/contrib/bc/src/lex.c index 2b705c8bc71b..d6f09f995a6a 100644 --- a/contrib/bc/src/lex.c +++ b/contrib/bc/src/lex.c @@ -38,14 +38,13 @@ #include <stdbool.h> #include <string.h> -#include <status.h> #include <lex.h> #include <vm.h> #include <bc.h> void bc_lex_invalidChar(BcLex *l, char c) { l->t = BC_LEX_INVALID; - bc_lex_verr(l, BC_ERROR_PARSE_CHAR, c); + bc_lex_verr(l, BC_ERR_PARSE_CHAR, c); } void bc_lex_lineComment(BcLex *l) { @@ -69,7 +68,7 @@ void bc_lex_comment(BcLex *l) { if (BC_ERR(!c || buf[i + 1] == '\0')) { l->i = i; - bc_lex_err(l, BC_ERROR_PARSE_COMMENT); + bc_lex_err(l, BC_ERR_PARSE_COMMENT); } end = buf[i + 1] == '/'; @@ -143,7 +142,7 @@ void bc_lex_number(BcLex *l, char start) { if (c == 'e') { #if BC_ENABLED - if (BC_IS_POSIX) bc_lex_err(l, BC_ERROR_POSIX_EXP_NUM); + if (BC_IS_POSIX) bc_lex_err(l, BC_ERR_POSIX_EXP_NUM); #endif // BC_ENABLED bc_vec_push(&l->str, &c); @@ -157,7 +156,7 @@ void bc_lex_number(BcLex *l, char start) { } if (BC_ERR(!BC_LEX_NUM_CHAR(c, false, true))) - bc_lex_verr(l, BC_ERROR_PARSE_CHAR, c); + bc_lex_verr(l, BC_ERR_PARSE_CHAR, c); l->i += bc_lex_num(l, 0, true); } @@ -208,7 +207,7 @@ void bc_lex_next(BcLex *l) { l->last = l->t; l->line += (l->i != 0 && l->buf[l->i - 1] == '\n'); - if (BC_ERR(l->last == BC_LEX_EOF)) bc_lex_err(l, BC_ERROR_PARSE_EOF); + if (BC_ERR(l->last == BC_LEX_EOF)) bc_lex_err(l, BC_ERR_PARSE_EOF); l->t = BC_LEX_EOF; diff --git a/contrib/bc/src/library.c b/contrib/bc/src/library.c new file mode 100644 index 000000000000..278b0f55a950 --- /dev/null +++ b/contrib/bc/src/library.c @@ -0,0 +1,1183 @@ +/* + * ***************************************************************************** + * + * SPDX-License-Identifier: BSD-2-Clause + * + * Copyright (c) 2018-2020 Gavin D. Howard and contributors. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * * Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + * ***************************************************************************** + * + * The public functions for libbc. + * + */ + +#if BC_ENABLE_LIBRARY + +#include <setjmp.h> +#include <string.h> +#include <time.h> + +#include <bcl.h> + +#include <library.h> +#include <num.h> +#include <vm.h> + +static void bcl_num_destruct(void *num); + +void bcl_handleSignal(void) { + + // Signal already in flight, or bc is not executing. + if (vm.sig || !vm.running) return; + + vm.sig = 1; + + assert(vm.jmp_bufs.len); + + if (!vm.sig_lock) BC_VM_JMP; +} + +bool bcl_running(void) { + return vm.running != 0; +} + +BclError bcl_init(void) { + + BclError e = BCL_ERROR_NONE; + + vm.refs += 1; + + if (vm.refs > 1) return e; + + vm.ctxts.v = NULL; + vm.jmp_bufs.v = NULL; + vm.out.v = NULL; + + vm.abrt = false; + + BC_SIG_LOCK; + + bc_vec_init(&vm.jmp_bufs, sizeof(sigjmp_buf), NULL); + + BC_FUNC_HEADER_INIT(err); + + bc_vm_init(); + + bc_vec_init(&vm.ctxts, sizeof(BclContext), NULL); + bc_vec_init(&vm.out, sizeof(uchar), NULL); + + srand((unsigned int) time(NULL)); + bc_rand_init(&vm.rng); + +err: + if (BC_ERR(vm.err)) { + if (vm.out.v != NULL) bc_vec_free(&vm.out); + if (vm.jmp_bufs.v != NULL) bc_vec_free(&vm.jmp_bufs); + if (vm.ctxts.v != NULL) bc_vec_free(&vm.ctxts); + } + + BC_FUNC_FOOTER_UNLOCK(e); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return e; +} + +BclError bcl_pushContext(BclContext ctxt) { + + BclError e = BCL_ERROR_NONE; + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_push(&vm.ctxts, &ctxt); + +err: + BC_FUNC_FOOTER_UNLOCK(e); + return e; +} + +void bcl_popContext(void) { + if (vm.ctxts.len) bc_vec_pop(&vm.ctxts); +} + +BclContext bcl_context(void) { + if (!vm.ctxts.len) return NULL; + return *((BclContext*) bc_vec_top(&vm.ctxts)); +} + +void bcl_free(void) { + + vm.refs -= 1; + + if (vm.refs) return; + + BC_SIG_LOCK; + +#ifndef NDEBUG + bc_rand_free(&vm.rng); + bc_vec_free(&vm.out); + + { + size_t i; + + for (i = 0; i < vm.ctxts.len; ++i) { + BclContext ctxt = *((BclContext*) bc_vec_item(&vm.ctxts, i)); + bcl_ctxt_free(ctxt); + } + } + + bc_vec_free(&vm.ctxts); +#endif // NDEBUG + + bc_vm_shutdown(); + + bc_vec_free(&vm.jmp_bufs); + + BC_SIG_UNLOCK; + + memset(&vm, 0, sizeof(BcVm)); + + assert(!vm.running && !vm.sig && !vm.sig_lock); +} + +void bcl_gc(void) { + bc_vm_freeTemps(); + vm.temps.len = 0; +} + +bool bcl_abortOnFatalError(void) { + return vm.abrt; +} + +void bcl_setAbortOnFatalError(bool abrt) { + vm.abrt = abrt; +} + +BclContext bcl_ctxt_create(void) { + + BclContext ctxt = NULL; + + BC_FUNC_HEADER_LOCK(err); + + ctxt = bc_vm_malloc(sizeof(BclCtxt)); + + bc_vec_init(&ctxt->nums, sizeof(BcNum), bcl_num_destruct); + bc_vec_init(&ctxt->free_nums, sizeof(BclNumber), NULL); + + ctxt->scale = 0; + ctxt->ibase = 10; + ctxt->obase= 10; + +err: + if (BC_ERR(vm.err && ctxt != NULL)) { + if (ctxt->nums.v != NULL) bc_vec_free(&ctxt->nums); + free(ctxt); + ctxt = NULL; + } + + BC_FUNC_FOOTER_NO_ERR; + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return ctxt; +} + +void bcl_ctxt_free(BclContext ctxt) { + BC_SIG_LOCK; + bc_vec_free(&ctxt->free_nums); + bc_vec_free(&ctxt->nums); + free(ctxt); + BC_SIG_UNLOCK; +} + +void bcl_ctxt_freeNums(BclContext ctxt) { + bc_vec_npop(&ctxt->nums, ctxt->nums.len); + bc_vec_npop(&ctxt->free_nums, ctxt->free_nums.len); +} + +size_t bcl_ctxt_scale(BclContext ctxt) { + return ctxt->scale; +} + +void bcl_ctxt_setScale(BclContext ctxt, size_t scale) { + ctxt->scale = scale; +} + +size_t bcl_ctxt_ibase(BclContext ctxt) { + return ctxt->ibase; +} + +void bcl_ctxt_setIbase(BclContext ctxt, size_t ibase) { + if (ibase < BC_NUM_MIN_BASE) ibase = BC_NUM_MIN_BASE; + else if (ibase > BC_NUM_MAX_IBASE) ibase = BC_NUM_MAX_IBASE; + ctxt->ibase = ibase; +} + +size_t bcl_ctxt_obase(BclContext ctxt) { + return ctxt->obase; +} + +void bcl_ctxt_setObase(BclContext ctxt, size_t obase) { + ctxt->obase = obase; +} + +BclError bcl_err(BclNumber n) { + + BclContext ctxt; + + BC_CHECK_CTXT_ERR(ctxt); + + if (n.i >= ctxt->nums.len) { + if (n.i > 0 - (size_t) BCL_ERROR_NELEMS) return (BclError) (0 - n.i); + else return BCL_ERROR_INVALID_NUM; + } + else return BCL_ERROR_NONE; +} + +static BclNumber bcl_num_insert(BclContext ctxt, BcNum *restrict n) { + + BclNumber idx; + + if (ctxt->free_nums.len) { + + BcNum *ptr; + + idx = *((BclNumber*) bc_vec_top(&ctxt->free_nums)); + + bc_vec_pop(&ctxt->free_nums); + + ptr = bc_vec_item(&ctxt->nums, idx.i); + memcpy(ptr, n, sizeof(BcNum)); + } + else { + idx.i = ctxt->nums.len; + bc_vec_push(&ctxt->nums, n); + } + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +BclNumber bcl_num_create(void) { + + BclError e = BCL_ERROR_NONE; + BcNum n; + BclNumber idx; + BclContext ctxt; + + BC_CHECK_CTXT(ctxt); + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_grow(&ctxt->nums, 1); + + bc_num_init(&n, BC_NUM_DEF_SIZE); + +err: + BC_FUNC_FOOTER_UNLOCK(e); + BC_MAYBE_SETUP(ctxt, e, n, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +static void bcl_num_dtor(BclContext ctxt, BclNumber n, BcNum *restrict num) { + + BC_SIG_ASSERT_LOCKED; + + assert(num != NULL && num->num != NULL); + + bcl_num_destruct(num); + bc_vec_push(&ctxt->free_nums, &n); +} + +void bcl_num_free(BclNumber n) { + + BcNum *num; + BclContext ctxt; + + BC_CHECK_CTXT_ASSERT(ctxt); + + BC_SIG_LOCK; + + assert(n.i < ctxt->nums.len); + + num = BC_NUM(ctxt, n); + + bcl_num_dtor(ctxt, n, num); + + BC_SIG_UNLOCK; +} + +BclError bcl_copy(BclNumber d, BclNumber s) { + + BclError e = BCL_ERROR_NONE; + BcNum *dest, *src; + BclContext ctxt; + + BC_CHECK_CTXT_ERR(ctxt); + + BC_FUNC_HEADER_LOCK(err); + + assert(d.i < ctxt->nums.len && s.i < ctxt->nums.len); + + dest = BC_NUM(ctxt, d); + src = BC_NUM(ctxt, s); + + assert(dest != NULL && src != NULL); + assert(dest->num != NULL && src->num != NULL); + + bc_num_copy(dest, src); + +err: + BC_FUNC_FOOTER_UNLOCK(e); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return e; +} + +BclNumber bcl_dup(BclNumber s) { + + BclError e = BCL_ERROR_NONE; + BcNum *src, dest; + BclNumber idx; + BclContext ctxt; + + BC_CHECK_CTXT(ctxt); + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_grow(&ctxt->nums, 1); + + assert(s.i < ctxt->nums.len); + + src = BC_NUM(ctxt, s); + + assert(src != NULL && src->num != NULL); + + bc_num_clear(&dest); + + bc_num_createCopy(&dest, src); + +err: + BC_FUNC_FOOTER_UNLOCK(e); + BC_MAYBE_SETUP(ctxt, e, dest, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +static void bcl_num_destruct(void *num) { + + BcNum *n = (BcNum*) num; + + assert(n != NULL); + + if (n->num == NULL) return; + + bc_num_free(num); + bc_num_clear(num); +} + +bool bcl_num_neg(BclNumber n) { + + BcNum *num; + BclContext ctxt; + + BC_CHECK_CTXT_ASSERT(ctxt); + + assert(n.i < ctxt->nums.len); + + num = BC_NUM(ctxt, n); + + assert(num != NULL && num->num != NULL); + + return BC_NUM_NEG(num) != 0; +} + +void bcl_num_setNeg(BclNumber n, bool neg) { + + BcNum *num; + BclContext ctxt; + + BC_CHECK_CTXT_ASSERT(ctxt); + + assert(n.i < ctxt->nums.len); + + num = BC_NUM(ctxt, n); + + assert(num != NULL && num->num != NULL); + + num->rdx = BC_NUM_NEG_VAL(num, neg); +} + +size_t bcl_num_scale(BclNumber n) { + + BcNum *num; + BclContext ctxt; + + BC_CHECK_CTXT_ASSERT(ctxt); + + assert(n.i < ctxt->nums.len); + + num = BC_NUM(ctxt, n); + + assert(num != NULL && num->num != NULL); + + return bc_num_scale(num); +} + +BclError bcl_num_setScale(BclNumber n, size_t scale) { + + BclError e = BCL_ERROR_NONE; + BcNum *nptr; + BclContext ctxt; + + BC_CHECK_CTXT_ERR(ctxt); + + BC_CHECK_NUM_ERR(ctxt, n); + + BC_FUNC_HEADER(err); + + assert(n.i < ctxt->nums.len); + + nptr = BC_NUM(ctxt, n); + + assert(nptr != NULL && nptr->num != NULL); + + if (scale > nptr->scale) bc_num_extend(nptr, scale - nptr->scale); + else if (scale < nptr->scale) bc_num_truncate(nptr, nptr->scale - scale); + +err: + BC_SIG_MAYLOCK; + BC_FUNC_FOOTER(e); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return e; +} + +size_t bcl_num_len(BclNumber n) { + + BcNum *num; + BclContext ctxt; + + BC_CHECK_CTXT_ASSERT(ctxt); + + assert(n.i < ctxt->nums.len); + + num = BC_NUM(ctxt, n); + + assert(num != NULL && num->num != NULL); + + return bc_num_len(num); +} + +BclError bcl_bigdig(BclNumber n, BclBigDig *result) { + + BclError e = BCL_ERROR_NONE; + BcNum *num; + BclContext ctxt; + + BC_CHECK_CTXT_ERR(ctxt); + + BC_FUNC_HEADER_LOCK(err); + + assert(n.i < ctxt->nums.len); + assert(result != NULL); + + num = BC_NUM(ctxt, n); + + assert(num != NULL && num->num != NULL); + + bc_num_bigdig(num, result); + +err: + bcl_num_dtor(ctxt, n, num); + BC_FUNC_FOOTER_UNLOCK(e); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return e; +} + +BclNumber bcl_bigdig2num(BclBigDig val) { + + BclError e = BCL_ERROR_NONE; + BcNum n; + BclNumber idx; + BclContext ctxt; + + BC_CHECK_CTXT(ctxt); + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_grow(&ctxt->nums, 1); + + bc_num_createFromBigdig(&n, val); + +err: + BC_FUNC_FOOTER_UNLOCK(e); + BC_MAYBE_SETUP(ctxt, e, n, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +static BclNumber bcl_binary(BclNumber a, BclNumber b, + const BcNumBinaryOp op, + const BcNumBinaryOpReq req) +{ + BclError e = BCL_ERROR_NONE; + BcNum *aptr, *bptr; + BcNum c; + BclNumber idx; + BclContext ctxt; + + BC_CHECK_CTXT(ctxt); + + BC_CHECK_NUM(ctxt, a); + BC_CHECK_NUM(ctxt, b); + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_grow(&ctxt->nums, 1); + + assert(a.i < ctxt->nums.len && b.i < ctxt->nums.len); + + aptr = BC_NUM(ctxt, a); + bptr = BC_NUM(ctxt, b); + + assert(aptr != NULL && bptr != NULL); + assert(aptr->num != NULL && bptr->num != NULL); + + bc_num_clear(&c); + + bc_num_init(&c, req(aptr, bptr, ctxt->scale)); + + BC_SIG_UNLOCK; + + op(aptr, bptr, &c, ctxt->scale); + +err: + BC_SIG_MAYLOCK; + bcl_num_dtor(ctxt, a, aptr); + if (b.i != a.i) bcl_num_dtor(ctxt, b, bptr); + BC_FUNC_FOOTER(e); + BC_MAYBE_SETUP(ctxt, e, c, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +BclNumber bcl_add(BclNumber a, BclNumber b) { + return bcl_binary(a, b, bc_num_add, bc_num_addReq); +} + +BclNumber bcl_sub(BclNumber a, BclNumber b) { + return bcl_binary(a, b, bc_num_sub, bc_num_addReq); +} + +BclNumber bcl_mul(BclNumber a, BclNumber b) { + return bcl_binary(a, b, bc_num_mul, bc_num_mulReq); +} + +BclNumber bcl_div(BclNumber a, BclNumber b) { + return bcl_binary(a, b, bc_num_div, bc_num_divReq); +} + +BclNumber bcl_mod(BclNumber a, BclNumber b) { + return bcl_binary(a, b, bc_num_mod, bc_num_divReq); +} + +BclNumber bcl_pow(BclNumber a, BclNumber b) { + return bcl_binary(a, b, bc_num_pow, bc_num_powReq); +} + +BclNumber bcl_lshift(BclNumber a, BclNumber b) { + return bcl_binary(a, b, bc_num_lshift, bc_num_placesReq); +} + +BclNumber bcl_rshift(BclNumber a, BclNumber b) { + return bcl_binary(a, b, bc_num_rshift, bc_num_placesReq); +} + +BclNumber bcl_sqrt(BclNumber a) { + + BclError e = BCL_ERROR_NONE; + BcNum *aptr; + BcNum b; + BclNumber idx; + BclContext ctxt; + + BC_CHECK_CTXT(ctxt); + + BC_CHECK_NUM(ctxt, a); + + BC_FUNC_HEADER(err); + + bc_vec_grow(&ctxt->nums, 1); + + assert(a.i < ctxt->nums.len); + + aptr = BC_NUM(ctxt, a); + + bc_num_sqrt(aptr, &b, ctxt->scale); + +err: + BC_SIG_MAYLOCK; + bcl_num_dtor(ctxt, a, aptr); + BC_FUNC_FOOTER(e); + BC_MAYBE_SETUP(ctxt, e, b, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +BclError bcl_divmod(BclNumber a, BclNumber b, BclNumber *c, BclNumber *d) { + + BclError e = BCL_ERROR_NONE; + size_t req; + BcNum *aptr, *bptr; + BcNum cnum, dnum; + BclContext ctxt; + + BC_CHECK_CTXT_ERR(ctxt); + + BC_CHECK_NUM_ERR(ctxt, a); + BC_CHECK_NUM_ERR(ctxt, b); + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_grow(&ctxt->nums, 2); + + assert(c != NULL && d != NULL); + + aptr = BC_NUM(ctxt, a); + bptr = BC_NUM(ctxt, b); + + assert(aptr != NULL && bptr != NULL); + assert(aptr->num != NULL && bptr->num != NULL); + + bc_num_clear(&cnum); + bc_num_clear(&dnum); + + req = bc_num_divReq(aptr, bptr, ctxt->scale); + + bc_num_init(&cnum, req); + bc_num_init(&dnum, req); + + BC_SIG_UNLOCK; + + bc_num_divmod(aptr, bptr, &cnum, &dnum, ctxt->scale); + +err: + BC_SIG_MAYLOCK; + + bcl_num_dtor(ctxt, a, aptr); + if (b.i != a.i) bcl_num_dtor(ctxt, b, bptr); + + if (BC_ERR(vm.err)) { + if (cnum.num != NULL) bc_num_free(&cnum); + if (dnum.num != NULL) bc_num_free(&dnum); + c->i = 0 - (size_t) BCL_ERROR_INVALID_NUM; + d->i = c->i; + BC_FUNC_FOOTER(e); + } + else { + BC_FUNC_FOOTER(e); + *c = bcl_num_insert(ctxt, &cnum); + *d = bcl_num_insert(ctxt, &dnum); + } + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return e; +} + +BclNumber bcl_modexp(BclNumber a, BclNumber b, BclNumber c) { + + BclError e = BCL_ERROR_NONE; + size_t req; + BcNum *aptr, *bptr, *cptr; + BcNum d; + BclNumber idx; + BclContext ctxt; + + BC_CHECK_CTXT(ctxt); + + BC_CHECK_NUM(ctxt, a); + BC_CHECK_NUM(ctxt, b); + BC_CHECK_NUM(ctxt, c); + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_grow(&ctxt->nums, 1); + + assert(a.i < ctxt->nums.len && b.i < ctxt->nums.len); + assert(c.i < ctxt->nums.len); + + aptr = BC_NUM(ctxt, a); + bptr = BC_NUM(ctxt, b); + cptr = BC_NUM(ctxt, c); + + assert(aptr != NULL && bptr != NULL && cptr != NULL); + assert(aptr->num != NULL && bptr->num != NULL && cptr->num != NULL); + + bc_num_clear(&d); + + req = bc_num_divReq(aptr, cptr, 0); + + bc_num_init(&d, req); + + BC_SIG_UNLOCK; + + bc_num_modexp(aptr, bptr, cptr, &d); + +err: + BC_SIG_MAYLOCK; + + bcl_num_dtor(ctxt, a, aptr); + if (b.i != a.i) bcl_num_dtor(ctxt, b, bptr); + if (c.i != a.i && c.i != b.i) bcl_num_dtor(ctxt, c, cptr); + + BC_FUNC_FOOTER(e); + BC_MAYBE_SETUP(ctxt, e, d, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +ssize_t bcl_cmp(BclNumber a, BclNumber b) { + + BcNum *aptr, *bptr; + BclContext ctxt; + + BC_CHECK_CTXT_ASSERT(ctxt); + + assert(a.i < ctxt->nums.len && b.i < ctxt->nums.len); + + aptr = BC_NUM(ctxt, a); + bptr = BC_NUM(ctxt, b); + + assert(aptr != NULL && bptr != NULL); + assert(aptr->num != NULL && bptr->num != NULL); + + return bc_num_cmp(aptr, bptr); +} + +void bcl_zero(BclNumber n) { + + BcNum *nptr; + BclContext ctxt; + + BC_CHECK_CTXT_ASSERT(ctxt); + + assert(n.i < ctxt->nums.len); + + nptr = BC_NUM(ctxt, n); + + assert(nptr != NULL && nptr->num != NULL); + + bc_num_zero(nptr); +} + +void bcl_one(BclNumber n) { + + BcNum *nptr; + BclContext ctxt; + + BC_CHECK_CTXT_ASSERT(ctxt); + + assert(n.i < ctxt->nums.len); + + nptr = BC_NUM(ctxt, n); + + assert(nptr != NULL && nptr->num != NULL); + + bc_num_one(nptr); +} + +BclNumber bcl_parse(const char *restrict val) { + + BclError e = BCL_ERROR_NONE; + BcNum n; + BclNumber idx; + BclContext ctxt; + bool neg; + + BC_CHECK_CTXT(ctxt); + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_grow(&ctxt->nums, 1); + + assert(val != NULL); + + neg = (val[0] == '-'); + + if (neg) val += 1; + + if (!bc_num_strValid(val)) { + vm.err = BCL_ERROR_PARSE_INVALID_STR; + goto err; + } + + bc_num_clear(&n); + + bc_num_init(&n, BC_NUM_DEF_SIZE); + + BC_SIG_UNLOCK; + + bc_num_parse(&n, val, (BcBigDig) ctxt->ibase); + + n.rdx = BC_NUM_NEG_VAL_NP(n, neg); + +err: + BC_SIG_MAYLOCK; + BC_FUNC_FOOTER(e); + BC_MAYBE_SETUP(ctxt, e, n, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +char* bcl_string(BclNumber n) { + + BcNum *nptr; + char *str = NULL; + BclContext ctxt; + + BC_CHECK_CTXT_ASSERT(ctxt); + + if (BC_ERR(n.i >= ctxt->nums.len)) return str; + + BC_FUNC_HEADER(err); + + assert(n.i < ctxt->nums.len); + + nptr = BC_NUM(ctxt, n); + + assert(nptr != NULL && nptr->num != NULL); + + bc_vec_npop(&vm.out, vm.out.len); + + bc_num_print(nptr, (BcBigDig) ctxt->obase, false); + bc_vec_pushByte(&vm.out, '\0'); + + BC_SIG_LOCK; + str = bc_vm_strdup(vm.out.v); + +err: + bcl_num_dtor(ctxt, n, nptr); + + BC_FUNC_FOOTER_NO_ERR; + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return str; +} + +BclNumber bcl_irand(BclNumber a) { + + BclError e = BCL_ERROR_NONE; + BcNum *aptr; + BcNum b; + BclNumber idx; + BclContext ctxt; + + BC_CHECK_CTXT(ctxt); + + BC_CHECK_NUM(ctxt, a); + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_grow(&ctxt->nums, 1); + + assert(a.i < ctxt->nums.len); + + aptr = BC_NUM(ctxt, a); + + assert(aptr != NULL && aptr->num != NULL); + + bc_num_clear(&b); + + bc_num_init(&b, BC_NUM_DEF_SIZE); + + BC_SIG_UNLOCK; + + bc_num_irand(aptr, &b, &vm.rng); + +err: + BC_SIG_MAYLOCK; + bcl_num_dtor(ctxt, a, aptr); + BC_FUNC_FOOTER(e); + BC_MAYBE_SETUP(ctxt, e, b, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +static void bcl_frandHelper(BcNum *restrict b, size_t places) { + + BcNum exp, pow, ten; + BcDig exp_digs[BC_NUM_BIGDIG_LOG10]; + BcDig ten_digs[BC_NUM_BIGDIG_LOG10]; + + bc_num_setup(&exp, exp_digs, BC_NUM_BIGDIG_LOG10); + bc_num_setup(&ten, ten_digs, BC_NUM_BIGDIG_LOG10); + + ten.num[0] = 10; + ten.len = 1; + + bc_num_bigdig2num(&exp, (BcBigDig) places); + + bc_num_clear(&pow); + + BC_SIG_LOCK; + + BC_SETJMP_LOCKED(err); + + bc_num_init(&pow, bc_num_powReq(&ten, &exp, 0)); + + BC_SIG_UNLOCK; + + bc_num_pow(&ten, &exp, &pow, 0); + + bc_num_irand(&pow, b, &vm.rng); + + bc_num_shiftRight(b, places); + +err: + BC_SIG_MAYLOCK; + bc_num_free(&pow); + BC_LONGJMP_CONT; +} + +BclNumber bcl_frand(size_t places) { + + BclError e = BCL_ERROR_NONE; + BcNum n; + BclNumber idx; + BclContext ctxt; + + BC_CHECK_CTXT(ctxt); + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_grow(&ctxt->nums, 1); + + bc_num_clear(&n); + + bc_num_init(&n, BC_NUM_DEF_SIZE); + + BC_SIG_UNLOCK; + + bcl_frandHelper(&n, places); + +err: + BC_SIG_MAYLOCK; + BC_FUNC_FOOTER(e); + BC_MAYBE_SETUP(ctxt, e, n, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +static void bcl_ifrandHelper(BcNum *restrict a, BcNum *restrict b, + size_t places) +{ + BcNum ir, fr; + + bc_num_clear(&ir); + bc_num_clear(&fr); + + BC_SIG_LOCK; + + BC_SETJMP_LOCKED(err); + + bc_num_init(&ir, BC_NUM_DEF_SIZE); + bc_num_init(&fr, BC_NUM_DEF_SIZE); + + BC_SIG_UNLOCK; + + bc_num_irand(a, &ir, &vm.rng); + bcl_frandHelper(&fr, places); + + bc_num_add(&ir, &fr, b, 0); + +err: + BC_SIG_MAYLOCK; + bc_num_free(&fr); + bc_num_free(&ir); + BC_LONGJMP_CONT; +} + +BclNumber bcl_ifrand(BclNumber a, size_t places) { + + BclError e = BCL_ERROR_NONE; + BcNum *aptr; + BcNum b; + BclNumber idx; + BclContext ctxt; + + BC_CHECK_CTXT(ctxt); + + BC_CHECK_NUM(ctxt, a); + + BC_FUNC_HEADER_LOCK(err); + + bc_vec_grow(&ctxt->nums, 1); + + assert(a.i < ctxt->nums.len); + + aptr = BC_NUM(ctxt, a); + + assert(aptr != NULL && aptr->num != NULL); + + bc_num_clear(&b); + + bc_num_init(&b, BC_NUM_DEF_SIZE); + + BC_SIG_UNLOCK; + + bcl_ifrandHelper(aptr, &b, places); + +err: + BC_SIG_MAYLOCK; + bcl_num_dtor(ctxt, a, aptr); + BC_FUNC_FOOTER(e); + BC_MAYBE_SETUP(ctxt, e, b, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +BclError bcl_rand_seedWithNum(BclNumber n) { + + BclError e = BCL_ERROR_NONE; + BcNum *nptr; + BclContext ctxt; + + BC_CHECK_CTXT_ERR(ctxt); + + BC_CHECK_NUM_ERR(ctxt, n); + + BC_FUNC_HEADER(err); + + assert(n.i < ctxt->nums.len); + + nptr = BC_NUM(ctxt, n); + + assert(nptr != NULL && nptr->num != NULL); + + bc_num_rng(nptr, &vm.rng); + +err: + BC_SIG_MAYLOCK; + BC_FUNC_FOOTER(e); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return e; +} + +BclError bcl_rand_seed(unsigned char seed[BC_SEED_SIZE]) { + + BclError e = BCL_ERROR_NONE; + size_t i; + ulong vals[BC_SEED_ULONGS]; + + BC_FUNC_HEADER(err); + + for (i = 0; i < BC_SEED_SIZE; ++i) { + ulong val = ((ulong) seed[i]) << (((ulong) CHAR_BIT) * + (i % sizeof(ulong))); + vals[i / sizeof(long)] |= val; + } + + bc_rand_seed(&vm.rng, vals[0], vals[1], vals[2], vals[3]); + +err: + BC_SIG_MAYLOCK; + BC_FUNC_FOOTER(e); + return e; +} + +void bcl_rand_reseed(void) { + bc_rand_srand(bc_vec_top(&vm.rng.v)); +} + +BclNumber bcl_rand_seed2num(void) { + + BclError e = BCL_ERROR_NONE; + BcNum n; + BclNumber idx; + BclContext ctxt; + + BC_CHECK_CTXT(ctxt); + + BC_FUNC_HEADER_LOCK(err); + + bc_num_clear(&n); + + bc_num_init(&n, BC_NUM_DEF_SIZE); + + BC_SIG_UNLOCK; + + bc_num_createFromRNG(&n, &vm.rng); + +err: + BC_SIG_MAYLOCK; + BC_FUNC_FOOTER(e); + BC_MAYBE_SETUP(ctxt, e, n, idx); + + assert(!vm.running && !vm.sig && !vm.sig_lock); + + return idx; +} + +BclRandInt bcl_rand_int(void) { + return (BclRandInt) bc_rand_int(&vm.rng); +} + +BclRandInt bcl_rand_bounded(BclRandInt bound) { + if (bound <= 1) return 0; + return (BclRandInt) bc_rand_bounded(&vm.rng, (BcRand) bound); +} + +#endif // BC_ENABLE_LIBRARY diff --git a/contrib/bc/src/main.c b/contrib/bc/src/main.c index 7e5e2905cf75..9c16e766e798 100644 --- a/contrib/bc/src/main.c +++ b/contrib/bc/src/main.c @@ -47,9 +47,6 @@ #include <bc.h> #include <dc.h> -char output_bufs[BC_VM_BUF_SIZE]; -BcVm vm; - int main(int argc, char *argv[]) { int s; diff --git a/contrib/bc/src/num.c b/contrib/bc/src/num.c index de5fa5c566fb..0b8823a3fec2 100644 --- a/contrib/bc/src/num.c +++ b/contrib/bc/src/num.c @@ -41,7 +41,6 @@ #include <setjmp.h> #include <limits.h> -#include <status.h> #include <num.h> #include <rand.h> #include <vm.h> @@ -53,11 +52,11 @@ static inline ssize_t bc_num_neg(size_t n, bool neg) { } ssize_t bc_num_cmpZero(const BcNum *n) { - return bc_num_neg((n)->len != 0, (n)->neg); + return bc_num_neg((n)->len != 0, BC_NUM_NEG(n)); } static inline size_t bc_num_int(const BcNum *n) { - return n->len ? n->len - n->rdx : 0; + return n->len ? n->len - BC_NUM_RDX_VAL(n) : 0; } static void bc_num_expand(BcNum *restrict n, size_t req) { @@ -81,10 +80,9 @@ static void bc_num_setToZero(BcNum *restrict n, size_t scale) { assert(n != NULL); n->scale = scale; n->len = n->rdx = 0; - n->neg = false; } -static inline void bc_num_zero(BcNum *restrict n) { +void bc_num_zero(BcNum *restrict n) { bc_num_setToZero(n, 0); } @@ -98,11 +96,11 @@ static void bc_num_clean(BcNum *restrict n) { while (BC_NUM_NONZERO(n) && !n->num[n->len - 1]) n->len -= 1; - if (BC_NUM_ZERO(n)) { - n->neg = false; - n->rdx = 0; + if (BC_NUM_ZERO(n)) n->rdx = 0; + else { + size_t rdx = BC_NUM_RDX_VAL(n); + if (n->len < rdx) n->len = rdx; } - else if (n->len < n->rdx) n->len = n->rdx; } static size_t bc_num_log10(size_t i) { @@ -126,7 +124,7 @@ static size_t bc_num_intDigits(const BcNum *n) { static size_t bc_num_nonzeroLen(const BcNum *restrict n) { size_t i, len = n->len; - assert(len == n->rdx); + assert(len == BC_NUM_RDX_VAL(n)); for (i = len - 1; i < len && !n->num[i]; --i); assert(i + 1 > 0); return i + 1; @@ -210,9 +208,9 @@ static void bc_num_mulArray(const BcNum *restrict a, BcBigDig b, bc_num_clean(c); - assert(!c->neg || BC_NUM_NONZERO(c)); - assert(c->rdx <= c->len || !c->len); - assert(!c->len || c->num[c->len - 1] || c->rdx == c->len); + assert(!BC_NUM_NEG(c) || BC_NUM_NONZERO(c)); + assert(BC_NUM_RDX_VAL(c) <= c->len || !c->len); + assert(!c->len || c->num[c->len - 1] || BC_NUM_RDX_VAL(c) == c->len); } static void bc_num_divArray(const BcNum *restrict a, BcBigDig b, @@ -234,9 +232,9 @@ static void bc_num_divArray(const BcNum *restrict a, BcBigDig b, bc_num_clean(c); *rem = carry; - assert(!c->neg || BC_NUM_NONZERO(c)); - assert(c->rdx <= c->len || !c->len); - assert(!c->len || c->num[c->len - 1] || c->rdx == c->len); + assert(!BC_NUM_NEG(c) || BC_NUM_NONZERO(c)); + assert(BC_NUM_RDX_VAL(c) <= c->len || !c->len); + assert(!c->len || c->num[c->len - 1] || BC_NUM_RDX_VAL(c) == c->len); } static ssize_t bc_num_compare(const BcDig *restrict a, const BcDig *restrict b, @@ -250,7 +248,7 @@ static ssize_t bc_num_compare(const BcDig *restrict a, const BcDig *restrict b, ssize_t bc_num_cmp(const BcNum *a, const BcNum *b) { - size_t i, min, a_int, b_int, diff; + size_t i, min, a_int, b_int, diff, ardx, brdx; BcDig *max_num, *min_num; bool a_max, neg = false; ssize_t cmp; @@ -258,13 +256,13 @@ ssize_t bc_num_cmp(const BcNum *a, const BcNum *b) { assert(a != NULL && b != NULL); if (a == b) return 0; - if (BC_NUM_ZERO(a)) return bc_num_neg(b->len != 0, !b->neg); + if (BC_NUM_ZERO(a)) return bc_num_neg(b->len != 0, !BC_NUM_NEG(b)); if (BC_NUM_ZERO(b)) return bc_num_cmpZero(a); - if (a->neg) { - if (b->neg) neg = true; + if (BC_NUM_NEG(a)) { + if (BC_NUM_NEG(b)) neg = true; else return -1; } - else if (b->neg) return 1; + else if (BC_NUM_NEG(b)) return 1; a_int = bc_num_int(a); b_int = bc_num_int(b); @@ -272,17 +270,19 @@ ssize_t bc_num_cmp(const BcNum *a, const BcNum *b) { if (a_int) return neg ? -((ssize_t) a_int) : (ssize_t) a_int; - a_max = (a->rdx > b->rdx); + ardx = BC_NUM_RDX_VAL(a); + brdx = BC_NUM_RDX_VAL(b); + a_max = (ardx > brdx); if (a_max) { - min = b->rdx; - diff = a->rdx - b->rdx; + min = brdx; + diff = ardx - brdx; max_num = a->num + diff; min_num = b->num; } else { - min = a->rdx; - diff = b->rdx - a->rdx; + min = ardx; + diff = brdx - ardx; max_num = b->num + diff; min_num = a->num; } @@ -300,15 +300,16 @@ ssize_t bc_num_cmp(const BcNum *a, const BcNum *b) { void bc_num_truncate(BcNum *restrict n, size_t places) { - size_t places_rdx; + size_t nrdx, places_rdx; if (!places) return; - places_rdx = n->rdx ? n->rdx - BC_NUM_RDX(n->scale - places) : 0; + nrdx = BC_NUM_RDX_VAL(n); + places_rdx = nrdx ? nrdx - BC_NUM_RDX(n->scale - places) : 0; assert(places <= n->scale && (BC_NUM_ZERO(n) || places_rdx <= n->len)); n->scale -= places; - n->rdx -= places_rdx; + BC_NUM_RDX_SET(n, nrdx - places_rdx); if (BC_NUM_NONZERO(n)) { @@ -328,9 +329,9 @@ void bc_num_truncate(BcNum *restrict n, size_t places) { } } -static void bc_num_extend(BcNum *restrict n, size_t places) { +void bc_num_extend(BcNum *restrict n, size_t places) { - size_t places_rdx; + size_t nrdx, places_rdx; if (!places) return; if (BC_NUM_ZERO(n)) { @@ -338,7 +339,8 @@ static void bc_num_extend(BcNum *restrict n, size_t places) { return; } - places_rdx = BC_NUM_RDX(places + n->scale) - n->rdx; + nrdx = BC_NUM_RDX_VAL(n); + places_rdx = BC_NUM_RDX(places + n->scale) - nrdx; if (places_rdx) { bc_num_expand(n, bc_vm_growSize(n->len, places_rdx)); @@ -346,11 +348,11 @@ static void bc_num_extend(BcNum *restrict n, size_t places) { memset(n->num, 0, BC_NUM_SIZE(places_rdx)); } - n->rdx += places_rdx; + BC_NUM_RDX_SET(n, nrdx + places_rdx); n->scale += places; n->len += places_rdx; - assert(n->rdx == BC_NUM_RDX(n->scale)); + assert(BC_NUM_RDX_VAL(n) == BC_NUM_RDX(n->scale)); } static void bc_num_retireMul(BcNum *restrict n, size_t scale, @@ -360,7 +362,7 @@ static void bc_num_retireMul(BcNum *restrict n, size_t scale, else bc_num_truncate(n, n->scale - scale); bc_num_clean(n); - if (BC_NUM_NONZERO(n)) n->neg = (!neg1 != !neg2); + if (BC_NUM_NONZERO(n)) n->rdx = BC_NUM_NEG_VAL(n, !neg1 != !neg2); } static void bc_num_split(const BcNum *restrict n, size_t idx, @@ -373,7 +375,9 @@ static void bc_num_split(const BcNum *restrict n, size_t idx, b->len = n->len - idx; a->len = idx; - a->scale = a->rdx = b->scale = b->rdx = 0; + a->scale = b->scale = 0; + BC_NUM_RDX_SET(a, 0); + BC_NUM_RDX_SET(b, 0); assert(a->cap >= a->len); assert(b->cap >= b->len); @@ -392,7 +396,7 @@ static size_t bc_num_shiftZero(BcNum *restrict n) { size_t i; - assert(!n->rdx || BC_NUM_ZERO(n)); + assert(!BC_NUM_RDX_VAL(n) || BC_NUM_ZERO(n)); for (i = 0; i < n->len && !n->num[i]; ++i); @@ -438,7 +442,7 @@ static void bc_num_shiftLeft(BcNum *restrict n, size_t places) { if (!places) return; if (places > n->scale) { size_t size = bc_vm_growSize(BC_NUM_RDX(places - n->scale), n->len); - if (size > SIZE_MAX - 1) bc_vm_err(BC_ERROR_MATH_OVERFLOW); + if (size > SIZE_MAX - 1) bc_vm_err(BC_ERR_MATH_OVERFLOW); } if (BC_NUM_ZERO(n)) { if (n->scale >= places) n->scale -= places; @@ -452,7 +456,9 @@ static void bc_num_shiftLeft(BcNum *restrict n, size_t places) { if (n->scale) { - if (n->rdx >= places_rdx) { + size_t nrdx = BC_NUM_RDX_VAL(n); + + if (nrdx >= places_rdx) { size_t mod = n->scale % BC_BASE_DIGS, revdig; @@ -462,7 +468,7 @@ static void bc_num_shiftLeft(BcNum *restrict n, size_t places) { if (mod + revdig > BC_BASE_DIGS) places_rdx = 1; else places_rdx = 0; } - else places_rdx -= n->rdx; + else places_rdx -= nrdx; } if (places_rdx) { @@ -472,10 +478,13 @@ static void bc_num_shiftLeft(BcNum *restrict n, size_t places) { n->len += places_rdx; } - if (places > n->scale) n->scale = n->rdx = 0; + if (places > n->scale) { + n->scale = 0; + BC_NUM_RDX_SET(n, 0); + } else { n->scale -= places; - n->rdx = BC_NUM_RDX(n->scale); + BC_NUM_RDX_SET(n, BC_NUM_RDX(n->scale)); } if (shift) bc_num_shift(n, BC_BASE_DIGS - dig); @@ -483,7 +492,7 @@ static void bc_num_shiftLeft(BcNum *restrict n, size_t places) { bc_num_clean(n); } -static void bc_num_shiftRight(BcNum *restrict n, size_t places) { +void bc_num_shiftRight(BcNum *restrict n, size_t places) { BcBigDig dig; size_t places_rdx, scale, scale_mod, int_len, expand; @@ -520,17 +529,18 @@ static void bc_num_shiftRight(BcNum *restrict n, size_t places) { bc_num_expand(n, bc_vm_growSize(expand, n->len)); memset(n->num + n->len, 0, BC_NUM_SIZE(expand)); n->len += expand; - n->scale = n->rdx = 0; + n->scale = 0; + BC_NUM_RDX_SET(n, 0); if (shift) bc_num_shift(n, dig); n->scale = scale + places; - n->rdx = BC_NUM_RDX(n->scale); + BC_NUM_RDX_SET(n, BC_NUM_RDX(n->scale)); bc_num_clean(n); - assert(n->rdx <= n->len && n->len <= n->cap); - assert(n->rdx == BC_NUM_RDX(n->scale)); + assert(BC_NUM_RDX_VAL(n) <= n->len && n->len <= n->cap); + assert(BC_NUM_RDX_VAL(n) == BC_NUM_RDX(n->scale)); } static void bc_num_inv(BcNum *a, BcNum *b, size_t scale) { @@ -550,7 +560,7 @@ static void bc_num_inv(BcNum *a, BcNum *b, size_t scale) { static void bc_num_intop(const BcNum *a, const BcNum *b, BcNum *restrict c, BcBigDig *v) { - if (BC_ERR(b->rdx)) bc_vm_err(BC_ERROR_MATH_NON_INTEGER); + if (BC_ERR(BC_NUM_RDX_VAL(b))) bc_vm_err(BC_ERR_MATH_NON_INTEGER); bc_num_copy(c, a); bc_num_bigdig(b, v); } @@ -560,8 +570,8 @@ static void bc_num_as(BcNum *a, BcNum *b, BcNum *restrict c, size_t sub) { BcDig *ptr_c, *ptr_l, *ptr_r; size_t i, min_rdx, max_rdx, diff, a_int, b_int, min_len, max_len, max_int; - size_t len_l, len_r; - bool b_neg, do_sub, do_rev_sub, carry; + size_t len_l, len_r, ardx, brdx; + bool b_neg, do_sub, do_rev_sub, carry, c_neg; // Because this function doesn't need to use scale (per the bc spec), // I am hijacking it to say whether it's doing an add or a subtract. @@ -573,23 +583,25 @@ static void bc_num_as(BcNum *a, BcNum *b, BcNum *restrict c, size_t sub) { } if (BC_NUM_ZERO(a)) { bc_num_copy(c, b); - c->neg = (b->neg != sub); + c->rdx = BC_NUM_NEG_VAL(c, BC_NUM_NEG(b) != sub); return; } // Invert sign of b if it is to be subtracted. This operation must // preced the tests for any of the operands being zero. - b_neg = (b->neg != sub); + b_neg = (BC_NUM_NEG(b) != sub); // Actually add the numbers if their signs are equal, else subtract. - do_sub = (a->neg != b_neg); + do_sub = (BC_NUM_NEG(a) != b_neg); a_int = bc_num_int(a); b_int = bc_num_int(b); max_int = BC_MAX(a_int, b_int); - min_rdx = BC_MIN(a->rdx, b->rdx); - max_rdx = BC_MAX(a->rdx, b->rdx); + ardx = BC_NUM_RDX_VAL(a); + brdx = BC_NUM_RDX_VAL(b); + min_rdx = BC_MIN(ardx, brdx); + max_rdx = BC_MAX(ardx, brdx); diff = max_rdx - min_rdx; max_len = max_int + max_rdx; @@ -598,7 +610,7 @@ static void bc_num_as(BcNum *a, BcNum *b, BcNum *restrict c, size_t sub) { // Check whether b has to be subtracted from a or a from b. if (a_int != b_int) do_rev_sub = (a_int < b_int); - else if (a->rdx > b->rdx) + else if (ardx > brdx) do_rev_sub = (bc_num_compare(a->num + diff, b->num, b->len) < 0); else do_rev_sub = (bc_num_compare(a->num, b->num + diff, a->len) <= 0); @@ -634,9 +646,9 @@ static void bc_num_as(BcNum *a, BcNum *b, BcNum *restrict c, size_t sub) { // If the rdx values of the operands do not match, the result will // have low end elements that are the positive or negative trailing // elements of the operand with higher rdx value. - if ((a->rdx > b->rdx) != do_rev_sub) { + if ((ardx > brdx) != do_rev_sub) { - // !do_rev_sub && a->rdx > b->rdx || do_rev_sub && b->rdx > a->rdx + // !do_rev_sub && ardx > brdx || do_rev_sub && brdx > ardx // The left operand has BcDig values that need to be copied, // either from a or from b (in case of a reversed subtraction). memcpy(ptr_c, ptr_l, BC_NUM_SIZE(diff)); @@ -649,14 +661,14 @@ static void bc_num_as(BcNum *a, BcNum *b, BcNum *restrict c, size_t sub) { // or subtracted from zero (in case of a subtraction). if (do_sub) { - // do_sub (do_rev_sub && a->rdx > b->rdx || - // !do_rev_sub && b->rdx > a->rdx) + // do_sub (do_rev_sub && ardx > brdx || + // !do_rev_sub && brdx > ardx) for (i = 0; i < diff; i++) ptr_c[i] = bc_num_subDigits(0, ptr_r[i], &carry); } else { - // !do_sub && b->rdx > a->rdx + // !do_sub && brdx > ardx memcpy(ptr_c, ptr_r, BC_NUM_SIZE(diff)); } @@ -691,9 +703,9 @@ static void bc_num_as(BcNum *a, BcNum *b, BcNum *restrict c, size_t sub) { // The result has the same sign as a, unless the operation was a // reverse subtraction (b - a). - c->neg = (a->neg != (do_sub && do_rev_sub)); + c_neg = BC_NUM_NEG(a) != (do_sub && do_rev_sub); + BC_NUM_RDX_SET_NEG(c, max_rdx, c_neg); c->len = max_len; - c->rdx = max_rdx; c->scale = BC_MAX(a->scale, b->scale); bc_num_clean(c); @@ -706,7 +718,7 @@ static void bc_num_m_simp(const BcNum *a, const BcNum *b, BcNum *restrict c) BcBigDig sum = 0, carry = 0; assert(sizeof(sum) >= sizeof(BcDig) * 2); - assert(!a->rdx && !b->rdx); + assert(!BC_NUM_RDX_VAL(a) && !BC_NUM_RDX_VAL(b)); clen = bc_vm_growSize(alen, blen); bc_num_expand(c, bc_vm_growSize(clen, 1)); @@ -751,7 +763,7 @@ static void bc_num_shiftAddSub(BcNum *restrict n, const BcNum *restrict a, size_t shift, BcNumShiftAddOp op) { assert(n->len >= shift + a->len); - assert(!n->rdx && !a->rdx); + assert(!BC_NUM_RDX_VAL(n) && !BC_NUM_RDX_VAL(a)); op(n->num + shift, a->num, a->len); } @@ -768,7 +780,7 @@ static void bc_num_k(BcNum *a, BcNum *b, BcNum *restrict c) { if (BC_NUM_ZERO(a) || BC_NUM_ZERO(b)) return; if (aone || BC_NUM_ONE(b)) { bc_num_copy(c, aone ? b : a); - if ((aone && a->neg) || b->neg) c->neg = !c->neg; + if ((aone && BC_NUM_NEG(a)) || BC_NUM_NEG(b)) BC_NUM_NEG_TGL(c); return; } if (a->len < BC_NUM_KARATSUBA_LEN || b->len < BC_NUM_KARATSUBA_LEN) { @@ -820,6 +832,9 @@ static void bc_num_k(BcNum *a, BcNum *b, BcNum *restrict c) { if (BC_NUM_NONZERO(&h1) && BC_NUM_NONZERO(&h2)) { + assert(BC_NUM_RDX_VALID_NP(h1)); + assert(BC_NUM_RDX_VALID_NP(h2)); + bc_num_m(&h1, &h2, &z2, 0); bc_num_clean(&z2); @@ -829,6 +844,9 @@ static void bc_num_k(BcNum *a, BcNum *b, BcNum *restrict c) { if (BC_NUM_NONZERO(&l1) && BC_NUM_NONZERO(&l2)) { + assert(BC_NUM_RDX_VALID_NP(l1)); + assert(BC_NUM_RDX_VALID_NP(l2)); + bc_num_m(&l1, &l2, &z0, 0); bc_num_clean(&z0); @@ -838,10 +856,14 @@ static void bc_num_k(BcNum *a, BcNum *b, BcNum *restrict c) { if (BC_NUM_NONZERO(&m1) && BC_NUM_NONZERO(&m2)) { + assert(BC_NUM_RDX_VALID_NP(m1)); + assert(BC_NUM_RDX_VALID_NP(m1)); + bc_num_m(&m1, &m2, &z1, 0); bc_num_clean(&z1); - op = (m1.neg != m2.neg) ? bc_num_subArrays : bc_num_addArrays; + op = (BC_NUM_NEG_NP(m1) != BC_NUM_NEG_NP(m2)) ? + bc_num_subArrays : bc_num_addArrays; bc_num_shiftAddSub(c, &z1, max2, op); } @@ -860,6 +882,9 @@ static void bc_num_m(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { BcNum cpa, cpb; size_t ascale, bscale, ardx, brdx, azero = 0, bzero = 0, zero, len, rscale; + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); + bc_num_zero(c); ascale = a->scale; bscale = b->scale; @@ -885,15 +910,19 @@ static void bc_num_m(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { bc_num_mulArray(operand, dig, c); - if (BC_NUM_NONZERO(c)) c->neg = (a->neg != b->neg); + if (BC_NUM_NONZERO(c)) + c->rdx = BC_NUM_NEG_VAL(c, BC_NUM_NEG(a) != BC_NUM_NEG(b)); return; } + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); + BC_SIG_LOCK; - bc_num_init(&cpa, a->len + a->rdx); - bc_num_init(&cpb, b->len + b->rdx); + bc_num_init(&cpa, a->len + BC_NUM_RDX_VAL(a)); + bc_num_init(&cpb, b->len + BC_NUM_RDX_VAL(b)); BC_SETJMP_LOCKED(err); @@ -902,12 +931,19 @@ static void bc_num_m(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { bc_num_copy(&cpa, a); bc_num_copy(&cpb, b); - cpa.neg = cpb.neg = false; + assert(BC_NUM_RDX_VALID_NP(cpa)); + assert(BC_NUM_RDX_VALID_NP(cpb)); + + BC_NUM_NEG_CLR_NP(cpa); + BC_NUM_NEG_CLR_NP(cpb); - ardx = cpa.rdx * BC_BASE_DIGS; + assert(BC_NUM_RDX_VALID_NP(cpa)); + assert(BC_NUM_RDX_VALID_NP(cpb)); + + ardx = BC_NUM_RDX_VAL_NP(cpa) * BC_BASE_DIGS; bc_num_shiftLeft(&cpa, ardx); - brdx = cpb.rdx * BC_BASE_DIGS; + brdx = BC_NUM_RDX_VAL_NP(cpb) * BC_BASE_DIGS; bc_num_shiftLeft(&cpb, brdx); // We need to reset the jump here because azero and bzero are used in the @@ -936,7 +972,7 @@ static void bc_num_m(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { bc_num_shiftLeft(c, (len - c->len) * BC_BASE_DIGS); bc_num_shiftRight(c, ardx + brdx); - bc_num_retireMul(c, scale, a->neg, b->neg); + bc_num_retireMul(c, scale, BC_NUM_NEG(a), BC_NUM_NEG(b)); err: BC_SIG_MAYLOCK; @@ -997,7 +1033,7 @@ static void bc_num_d_long(BcNum *restrict a, BcNum *restrict b, bc_num_expand(c, a->len); memset(c->num, 0, c->cap * sizeof(BcDig)); - c->rdx = a->rdx; + BC_NUM_RDX_SET(c, BC_NUM_RDX_VAL(a)); c->scale = a->scale; c->len = a->len; @@ -1030,7 +1066,7 @@ static void bc_num_d_long(BcNum *restrict a, BcNum *restrict b, memset(c->num, 0, BC_NUM_SIZE(c->cap)); assert(c->scale >= scale); - rdx = c->rdx - BC_NUM_RDX(scale); + rdx = BC_NUM_RDX_VAL(c) - BC_NUM_RDX(scale); BC_SIG_LOCK; @@ -1094,27 +1130,27 @@ err: static void bc_num_d(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { - size_t len; + size_t len, cpardx; BcNum cpa, cpb; - if (BC_NUM_ZERO(b)) bc_vm_err(BC_ERROR_MATH_DIVIDE_BY_ZERO); + if (BC_NUM_ZERO(b)) bc_vm_err(BC_ERR_MATH_DIVIDE_BY_ZERO); if (BC_NUM_ZERO(a)) { bc_num_setToZero(c, scale); return; } if (BC_NUM_ONE(b)) { bc_num_copy(c, a); - bc_num_retireMul(c, scale, a->neg, b->neg); + bc_num_retireMul(c, scale, BC_NUM_NEG(a), BC_NUM_NEG(b)); return; } - if (!a->rdx && !b->rdx && b->len == 1 && !scale) { + if (!BC_NUM_RDX_VAL(a) && !BC_NUM_RDX_VAL(b) && b->len == 1 && !scale) { BcBigDig rem; bc_num_divArray(a, (BcBigDig) b->num[0], c, &rem); - bc_num_retireMul(c, scale, a->neg, b->neg); + bc_num_retireMul(c, scale, BC_NUM_NEG(a), BC_NUM_NEG(b)); return; } - len = bc_num_mulReq(a, b, scale); + len = bc_num_divReq(a, b, scale); BC_SIG_LOCK; @@ -1133,15 +1169,18 @@ static void bc_num_d(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { bc_num_extend(&cpa, (len - cpa.len) * BC_BASE_DIGS); } - cpa.scale = cpa.rdx * BC_BASE_DIGS; + cpardx = BC_NUM_RDX_VAL_NP(cpa); + cpa.scale = cpardx * BC_BASE_DIGS; bc_num_extend(&cpa, b->scale); - cpa.rdx -= BC_NUM_RDX(b->scale); - cpa.scale = cpa.rdx * BC_BASE_DIGS; + cpardx = BC_NUM_RDX_VAL_NP(cpa) - BC_NUM_RDX(b->scale); + BC_NUM_RDX_SET_NP(cpa, cpardx); + cpa.scale = cpardx * BC_BASE_DIGS; if (scale > cpa.scale) { bc_num_extend(&cpa, scale); - cpa.scale = cpa.rdx * BC_BASE_DIGS; + cpardx = BC_NUM_RDX_VAL_NP(cpa); + cpa.scale = cpardx * BC_BASE_DIGS; } if (cpa.cap == cpa.len) bc_num_expand(&cpa, bc_vm_growSize(cpa.len, 1)); @@ -1149,13 +1188,14 @@ static void bc_num_d(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { // We want an extra zero in front to make things simpler. cpa.num[cpa.len++] = 0; - if (cpa.rdx == cpa.len) cpa.len = bc_num_nonzeroLen(&cpa); - if (cpb.rdx == cpb.len) cpb.len = bc_num_nonzeroLen(&cpb); - cpb.scale = cpb.rdx = 0; + if (cpardx == cpa.len) cpa.len = bc_num_nonzeroLen(&cpa); + if (BC_NUM_RDX_VAL_NP(cpb) == cpb.len) cpb.len = bc_num_nonzeroLen(&cpb); + cpb.scale = 0; + BC_NUM_RDX_SET_NP(cpb, 0); bc_num_d_long(&cpa, &cpb, c, scale); - bc_num_retireMul(c, scale, a->neg, b->neg); + bc_num_retireMul(c, scale, BC_NUM_NEG(a), BC_NUM_NEG(b)); err: BC_SIG_MAYLOCK; @@ -1170,7 +1210,7 @@ static void bc_num_r(BcNum *a, BcNum *b, BcNum *restrict c, BcNum temp; bool neg; - if (BC_NUM_ZERO(b)) bc_vm_err(BC_ERROR_MATH_DIVIDE_BY_ZERO); + if (BC_NUM_ZERO(b)) bc_vm_err(BC_ERR_MATH_DIVIDE_BY_ZERO); if (BC_NUM_ZERO(a)) { bc_num_setToZero(c, ts); bc_num_setToZero(d, ts); @@ -1189,14 +1229,17 @@ static void bc_num_r(BcNum *a, BcNum *b, BcNum *restrict c, if (scale) scale = ts + 1; + assert(BC_NUM_RDX_VALID(c)); + assert(BC_NUM_RDX_VALID(b)); + bc_num_m(c, b, &temp, scale); bc_num_sub(a, &temp, d, scale); if (ts > d->scale && BC_NUM_NONZERO(d)) bc_num_extend(d, ts - d->scale); - neg = d->neg; - bc_num_retireMul(d, ts, a->neg, b->neg); - d->neg = BC_NUM_NONZERO(d) ? neg : false; + neg = BC_NUM_NEG(d); + bc_num_retireMul(d, ts, BC_NUM_NEG(a), BC_NUM_NEG(b)); + d->rdx = BC_NUM_NEG_VAL(d, BC_NUM_NONZERO(d) ? neg : false); err: BC_SIG_MAYLOCK; @@ -1235,29 +1278,29 @@ static void bc_num_p(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { size_t i, powrdx, resrdx; bool neg, zero; - if (BC_ERR(b->rdx)) bc_vm_err(BC_ERROR_MATH_NON_INTEGER); + if (BC_ERR(BC_NUM_RDX_VAL(b))) bc_vm_err(BC_ERR_MATH_NON_INTEGER); if (BC_NUM_ZERO(b)) { bc_num_one(c); return; } if (BC_NUM_ZERO(a)) { - if (b->neg) bc_vm_err(BC_ERROR_MATH_DIVIDE_BY_ZERO); + if (BC_NUM_NEG(b)) bc_vm_err(BC_ERR_MATH_DIVIDE_BY_ZERO); bc_num_setToZero(c, scale); return; } if (BC_NUM_ONE(b)) { - if (!b->neg) bc_num_copy(c, a); + if (!BC_NUM_NEG(b)) bc_num_copy(c, a); else bc_num_inv(a, c, scale); return; } BC_SIG_LOCK; - neg = b->neg; - b->neg = false; + neg = BC_NUM_NEG(b); + BC_NUM_NEG_CLR(b); bc_num_bigdig(b, &pow); - b->neg = neg; + b->rdx = BC_NUM_NEG_VAL(b, neg); bc_num_createCopy(©, a); @@ -1272,6 +1315,7 @@ static void bc_num_p(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { for (powrdx = a->scale; !(pow & 1); pow >>= 1) { powrdx <<= 1; + assert(BC_NUM_RDX_VALID_NP(copy)); bc_num_mul(©, ©, ©, powrdx); } @@ -1281,10 +1325,13 @@ static void bc_num_p(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { while (pow >>= 1) { powrdx <<= 1; + assert(BC_NUM_RDX_VALID_NP(copy)); bc_num_mul(©, ©, ©, powrdx); if (pow & 1) { resrdx += powrdx; + assert(BC_NUM_RDX_VALID(c)); + assert(BC_NUM_RDX_VALID_NP(copy)); bc_num_mul(c, ©, c, resrdx); } } @@ -1344,11 +1391,14 @@ static void bc_num_right(BcNum *a, BcNum *b, BcNum *restrict c, size_t scale) { static void bc_num_binary(BcNum *a, BcNum *b, BcNum *c, size_t scale, BcNumBinaryOp op, size_t req) { - BcNum num2, *ptr_a, *ptr_b; + BcNum *ptr_a, *ptr_b, num2; bool init = false; assert(a != NULL && b != NULL && c != NULL && op != NULL); + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); + BC_SIG_LOCK; if (c == a) { @@ -1358,7 +1408,9 @@ static void bc_num_binary(BcNum *a, BcNum *b, BcNum *c, size_t scale, memcpy(ptr_a, c, sizeof(BcNum)); init = true; } - else ptr_a = a; + else { + ptr_a = a; + } if (c == b) { @@ -1369,7 +1421,9 @@ static void bc_num_binary(BcNum *a, BcNum *b, BcNum *c, size_t scale, init = true; } } - else ptr_b = b; + else { + ptr_b = b; + } if (init) { @@ -1385,9 +1439,10 @@ static void bc_num_binary(BcNum *a, BcNum *b, BcNum *c, size_t scale, op(ptr_a, ptr_b, c, scale); - assert(!c->neg || BC_NUM_NONZERO(c)); - assert(c->rdx <= c->len || !c->len); - assert(!c->len || c->num[c->len - 1] || c->rdx == c->len); + assert(!BC_NUM_NEG(c) || BC_NUM_NONZERO(c)); + assert(BC_NUM_RDX_VAL(c) <= c->len || !c->len); + assert(BC_NUM_RDX_VALID(c)); + assert(!c->len || c->num[c->len - 1] || BC_NUM_RDX_VAL(c) == c->len); err: if (init) { @@ -1397,8 +1452,8 @@ err: } } -#ifndef NDEBUG -static bool bc_num_strValid(const char *val) { +#if !defined(NDEBUG) || BC_ENABLE_LIBRARY +bool bc_num_strValid(const char *restrict val) { bool radix = false; size_t i, len = strlen(val); @@ -1422,7 +1477,7 @@ static bool bc_num_strValid(const char *val) { return true; } -#endif // NDEBUG +#endif // !defined(NDEBUG) || BC_ENABLE_LIBRARY static BcBigDig bc_num_parseChar(char c, size_t base_t) { @@ -1459,8 +1514,8 @@ static void bc_num_parseDecimal(BcNum *restrict n, const char *restrict val) { n->scale = (size_t) (rdx * (((uintptr_t) (val + len)) - (((uintptr_t) ptr) + 1))); - n->rdx = BC_NUM_RDX(n->scale); + BC_NUM_RDX_SET(n, BC_NUM_RDX(n->scale)); i = len - (ptr == val ? 0 : i) - rdx; temp = BC_NUM_ROUND_POW(i); mod = n->scale % BC_BASE_DIGS; @@ -1470,7 +1525,11 @@ static void bc_num_parseDecimal(BcNum *restrict n, const char *restrict val) { bc_num_expand(n, n->len); memset(n->num, 0, BC_NUM_SIZE(n->len)); - if (zero) n->len = n->rdx = 0; + if (zero) { + // I think I can set rdx directly to zero here because n should be a + // new number with sign set to false. + n->len = n->rdx = 0; + } else { BcBigDig exp, pow; @@ -1551,6 +1610,8 @@ static void bc_num_parseBase(BcNum *restrict n, const char *restrict val, for (i += 1, digs = 0; i < len && (c = val[i]); ++i, ++digs) { + size_t rdx; + v = bc_num_parseChar(c, base); bc_num_mulArray(&result1, base, &result2); @@ -1559,7 +1620,9 @@ static void bc_num_parseBase(BcNum *restrict n, const char *restrict val, bc_num_add(&result2, &temp, &result1, 0); bc_num_mulArray(m1, base, m2); - if (m2->len < m2->rdx) m2->len = m2->rdx; + rdx = BC_NUM_RDX_VAL(m2); + + if (m2->len < rdx) m2->len = rdx; ptr = m1; m1 = m2; @@ -1589,11 +1652,13 @@ int_err: BC_LONGJMP_CONT; } -static void bc_num_printNewline(void) { +static inline void bc_num_printNewline(void) { +#if !BC_ENABLE_LIBRARY if (vm.nchars >= vm.line_len - 1) { bc_vm_putchar('\\'); bc_vm_putchar('\n'); } +#endif // !BC_ENABLE_LIBRARY } static void bc_num_putchar(int c) { @@ -1601,14 +1666,14 @@ static void bc_num_putchar(int c) { bc_vm_putchar(c); } -#if DC_ENABLED +#if DC_ENABLED && !BC_ENABLE_LIBRARY static void bc_num_printChar(size_t n, size_t len, bool rdx) { BC_UNUSED(rdx); BC_UNUSED(len); assert(len == 1); bc_vm_putchar((uchar) n); } -#endif // DC_ENABLED +#endif // DC_ENABLED && !BC_ENABLE_LIBRARY static void bc_num_printDigits(size_t n, size_t len, bool rdx) { @@ -1638,11 +1703,11 @@ static void bc_num_printHex(size_t n, size_t len, bool rdx) { static void bc_num_printDecimal(const BcNum *restrict n) { - size_t i, j, rdx = n->rdx; + size_t i, j, rdx = BC_NUM_RDX_VAL(n); bool zero = true; size_t buffer[BC_BASE_DIGS]; - if (n->neg) bc_num_putchar('-'); + if (BC_NUM_NEG(n)) bc_num_putchar('-'); for (i = n->len - 1; i < n->len; --i) { @@ -1672,9 +1737,9 @@ static void bc_num_printDecimal(const BcNum *restrict n) { #if BC_ENABLE_EXTRA_MATH static void bc_num_printExponent(const BcNum *restrict n, bool eng) { - bool neg = (n->len <= n->rdx); + size_t places, mod, nrdx = BC_NUM_RDX_VAL(n); + bool neg = (n->len <= nrdx); BcNum temp, exp; - size_t places, mod; BcDig digs[BC_NUM_BIGDIG_LOG10]; BC_SIG_LOCK; @@ -1696,7 +1761,7 @@ static void bc_num_printExponent(const BcNum *restrict n, bool eng) { else break; } - places += (n->rdx - (idx + 1)) * BC_BASE_DIGS; + places += (nrdx - (idx + 1)) * BC_BASE_DIGS; mod = places % 3; if (eng && mod != 0) places += 3 - mod; @@ -1799,7 +1864,7 @@ static void bc_num_printNum(BcNum *restrict n, BcBigDig base, BcVec stack; BcNum intp, fracp1, fracp2, digit, flen1, flen2, *n1, *n2, *temp; BcBigDig dig = 0, *ptr, acc, exp; - size_t i, j; + size_t i, j, nrdx; bool radix; BcDig digit_digs[BC_NUM_BIGDIG_LOG10 + 1]; @@ -1843,10 +1908,12 @@ static void bc_num_printNum(BcNum *restrict n, BcBigDig base, // happens and bc_num_printFixup() where the inner loop, or actual // conversion, happens. + nrdx = BC_NUM_RDX_VAL(n); + BC_SIG_LOCK; bc_vec_init(&stack, sizeof(BcBigDig), NULL); - bc_num_init(&fracp1, n->rdx); + bc_num_init(&fracp1, nrdx); bc_num_createCopy(&intp, n); @@ -1911,7 +1978,7 @@ static void bc_num_printNum(BcNum *restrict n, BcBigDig base, BC_UNSETJMP; - bc_num_init(&fracp2, n->rdx); + bc_num_init(&fracp2, nrdx); bc_num_setup(&digit, digit_digs, sizeof(digit_digs) / sizeof(BcDig)); bc_num_init(&flen1, BC_NUM_BIGDIG_LOG10); bc_num_init(&flen2, BC_NUM_BIGDIG_LOG10); @@ -1927,13 +1994,16 @@ static void bc_num_printNum(BcNum *restrict n, BcBigDig base, n2 = &flen2; fracp2.scale = n->scale; - fracp2.rdx = BC_NUM_RDX(fracp2.scale); + BC_NUM_RDX_SET_NP(fracp2, BC_NUM_RDX(fracp2.scale)); while (bc_num_intDigits(n1) < n->scale + 1) { bc_num_expand(&fracp2, fracp1.len + 1); bc_num_mulArray(&fracp1, base, &fracp2); - if (fracp2.len < fracp2.rdx) fracp2.len = fracp2.rdx; + + nrdx = BC_NUM_RDX_VAL_NP(fracp2); + + if (fracp2.len < nrdx) fracp2.len = nrdx; // fracp is guaranteed to be non-negative and small enough. bc_num_bigdig2(&fracp2, &dig); @@ -1967,11 +2037,11 @@ static void bc_num_printBase(BcNum *restrict n, BcBigDig base) { size_t width; BcNumDigitOp print; - bool neg = n->neg; + bool neg = BC_NUM_NEG(n); if (neg) bc_num_putchar('-'); - n->neg = false; + BC_NUM_NEG_CLR(n); if (base <= BC_NUM_MAX_POSIX_IBASE) { width = 1; @@ -1984,14 +2054,14 @@ static void bc_num_printBase(BcNum *restrict n, BcBigDig base) { } bc_num_printNum(n, base, width, print); - n->neg = neg; + n->rdx = BC_NUM_NEG_VAL(n, neg); } -#if DC_ENABLED +#if DC_ENABLED && !BC_ENABLE_LIBRARY void bc_num_stream(BcNum *restrict n, BcBigDig base) { bc_num_printNum(n, base, 1, bc_num_printChar); } -#endif // DC_ENABLED +#endif // DC_ENABLED && !BC_ENABLE_LIBRARY void bc_num_setup(BcNum *restrict n, BcDig *restrict num, size_t cap) { assert(n != NULL); @@ -2042,7 +2112,7 @@ void bc_num_copy(BcNum *d, const BcNum *s) { if (d == s) return; bc_num_expand(d, s->len); d->len = s->len; - d->neg = s->neg; + // I can just copy directly here. d->rdx = s->rdx; d->scale = s->scale; memcpy(d->num, s->num, BC_NUM_SIZE(d->len)); @@ -2056,7 +2126,7 @@ void bc_num_createCopy(BcNum *d, const BcNum *s) { void bc_num_createFromBigdig(BcNum *n, BcBigDig val) { BC_SIG_ASSERT_LOCKED; - bc_num_init(n, (BC_NUM_BIGDIG_LOG10 - 1) / BC_BASE_DIGS + 1); + bc_num_init(n, BC_NUM_BIGDIG_LOG10); bc_num_bigdig2num(n, val); } @@ -2070,7 +2140,7 @@ size_t bc_num_len(const BcNum *restrict n) { if (BC_NUM_ZERO(n)) return 0; - if (n->rdx == len) { + if (BC_NUM_RDX_VAL(n) == len) { size_t zero, scale; @@ -2088,19 +2158,20 @@ size_t bc_num_len(const BcNum *restrict n) { return len; } -void bc_num_parse(BcNum *restrict n, const char *restrict val, - BcBigDig base, bool letter) -{ +void bc_num_parse(BcNum *restrict n, const char *restrict val, BcBigDig base) { + assert(n != NULL && val != NULL && base); assert(base >= BC_NUM_MIN_BASE && base <= vm.maxes[BC_PROG_GLOBALS_IBASE]); assert(bc_num_strValid(val)); - if (letter) { + if (!val[1]) { BcBigDig dig = bc_num_parseChar(val[0], BC_NUM_MAX_LBASE); bc_num_bigdig2num(n, dig); } else if (base == BC_BASE) bc_num_parseDecimal(n, val); else bc_num_parseBase(n, val, base); + + assert(BC_NUM_RDX_VALID(n)); } void bc_num_print(BcNum *restrict n, BcBigDig base, bool newline) { @@ -2113,8 +2184,7 @@ void bc_num_print(BcNum *restrict n, BcBigDig base, bool newline) { if (BC_NUM_ZERO(n)) bc_num_printHex(0, 1, false); else if (base == BC_BASE) bc_num_printDecimal(n); #if BC_ENABLE_EXTRA_MATH - else if (base == 0 || base == 1) - bc_num_printExponent(n, base != 0); + else if (base == 0 || base == 1) bc_num_printExponent(n, base != 0); #endif // BC_ENABLE_EXTRA_MATH else bc_num_printBase(n, base); @@ -2127,28 +2197,38 @@ void bc_num_bigdig2(const BcNum *restrict n, BcBigDig *result) { // its preconditions are met. Those preconditions include both parameters // being non-NULL, n being non-negative, and n being less than vm.max. If // all of that is true, then we can just convert without worrying about - // negative errors or overflow. We also don't care about signals because - // this function should execute in only a few iterations, meaning that - // ignoring signals here should be fine. + // negative errors or overflow. BcBigDig r = 0; + size_t nrdx = BC_NUM_RDX_VAL(n); assert(n != NULL && result != NULL); - assert(!n->neg); + assert(!BC_NUM_NEG(n)); assert(bc_num_cmp(n, &vm.max) < 0); - assert(n->len - n->rdx <= 3); + assert(n->len - nrdx <= 3); // There is a small speed win from unrolling the loop here, and since it // only adds 53 bytes, I decided that it was worth it. - switch (n->len - n->rdx) { + switch (n->len - nrdx) { + case 3: - r = (BcBigDig) n->num[n->rdx + 2]; - // Fallthrough. + { + r = (BcBigDig) n->num[nrdx + 2]; + } + // Fallthrough. + BC_FALLTHROUGH + case 2: - r = r * BC_BASE_POW + (BcBigDig) n->num[n->rdx + 1]; - // Fallthrough. + { + r = r * BC_BASE_POW + (BcBigDig) n->num[nrdx + 1]; + } + // Fallthrough. + BC_FALLTHROUGH + case 1: - r = r * BC_BASE_POW + (BcBigDig) n->num[n->rdx]; + { + r = r * BC_BASE_POW + (BcBigDig) n->num[nrdx]; + } } *result = r; @@ -2158,9 +2238,9 @@ void bc_num_bigdig(const BcNum *restrict n, BcBigDig *result) { assert(n != NULL && result != NULL); - if (BC_ERR(n->neg)) bc_vm_err(BC_ERROR_MATH_NEGATIVE); + if (BC_ERR(BC_NUM_NEG(n))) bc_vm_err(BC_ERR_MATH_NEGATIVE); if (BC_ERR(bc_num_cmp(n, &vm.max) >= 0)) - bc_vm_err(BC_ERROR_MATH_OVERFLOW); + bc_vm_err(BC_ERR_MATH_OVERFLOW); bc_num_bigdig2(n, result); } @@ -2187,41 +2267,41 @@ void bc_num_bigdig2num(BcNum *restrict n, BcBigDig val) { #if BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND void bc_num_rng(const BcNum *restrict n, BcRNG *rng) { - BcNum pow, temp, temp2, intn, frac; + BcNum temp, temp2, intn, frac; BcRand state1, state2, inc1, inc2; - BcDig pow_num[BC_RAND_NUM_SIZE]; - - bc_num_setup(&pow, pow_num, sizeof(pow_num) / sizeof(BcDig)); + size_t nrdx = BC_NUM_RDX_VAL(n); BC_SIG_LOCK; bc_num_init(&temp, n->len); bc_num_init(&temp2, n->len); - bc_num_init(&frac, n->rdx); + bc_num_init(&frac, nrdx); bc_num_init(&intn, bc_num_int(n)); BC_SETJMP_LOCKED(err); BC_SIG_UNLOCK; - bc_num_mul(&vm.max, &vm.max, &pow, 0); + assert(BC_NUM_RDX_VALID_NP(vm.max)); - memcpy(frac.num, n->num, BC_NUM_SIZE(n->rdx)); - frac.len = n->rdx; - frac.rdx = n->rdx; + memcpy(frac.num, n->num, BC_NUM_SIZE(nrdx)); + frac.len = nrdx; + BC_NUM_RDX_SET_NP(frac, nrdx); frac.scale = n->scale; - bc_num_mul(&frac, &pow, &temp, 0); + assert(BC_NUM_RDX_VALID_NP(frac)); + assert(BC_NUM_RDX_VALID_NP(vm.max2)); + + bc_num_mul(&frac, &vm.max2, &temp, 0); bc_num_truncate(&temp, temp.scale); bc_num_copy(&frac, &temp); - memcpy(intn.num, n->num + n->rdx, BC_NUM_SIZE(bc_num_int(n))); + memcpy(intn.num, n->num + nrdx, BC_NUM_SIZE(bc_num_int(n))); intn.len = bc_num_int(n); // This assert is here because it has to be true. It is also here to justify - // the use of BC_ERROR_SIGNAL_ONLY() on each of the divmod's and mod's - // below. + // the use of BC_ERR_SIGNAL_ONLY() on each of the divmod's and mod's below. assert(BC_NUM_NONZERO(&vm.max)); if (BC_NUM_NONZERO(&frac)) { @@ -2271,8 +2351,7 @@ err: void bc_num_createFromRNG(BcNum *restrict n, BcRNG *rng) { BcRand s1, s2, i1, i2; - BcNum pow, conv, temp1, temp2, temp3; - BcDig pow_num[BC_RAND_NUM_SIZE]; + BcNum conv, temp1, temp2, temp3; BcDig temp1_num[BC_RAND_NUM_SIZE], temp2_num[BC_RAND_NUM_SIZE]; BcDig conv_num[BC_NUM_BIGDIG_LOG10]; @@ -2284,35 +2363,36 @@ void bc_num_createFromRNG(BcNum *restrict n, BcRNG *rng) { BC_SIG_UNLOCK; - bc_num_setup(&pow, pow_num, sizeof(pow_num) / sizeof(BcDig)); bc_num_setup(&temp1, temp1_num, sizeof(temp1_num) / sizeof(BcDig)); bc_num_setup(&temp2, temp2_num, sizeof(temp2_num) / sizeof(BcDig)); bc_num_setup(&conv, conv_num, sizeof(conv_num) / sizeof(BcDig)); // This assert is here because it has to be true. It is also here to justify - // the assumption that pow is not zero. + // the assumption that vm.max2 is not zero. assert(BC_NUM_NONZERO(&vm.max)); - bc_num_mul(&vm.max, &vm.max, &pow, 0); - - // Because this is true, we can just use BC_ERROR_SIGNAL_ONLY() below when - // dividing by pow. - assert(BC_NUM_NONZERO(&pow)); + // Because this is true, we can just use BC_ERR_SIGNAL_ONLY() below when + // dividing by vm.max2. + assert(BC_NUM_NONZERO(&vm.max2)); bc_rand_getRands(rng, &s1, &s2, &i1, &i2); bc_num_bigdig2num(&conv, (BcBigDig) s2); + assert(BC_NUM_RDX_VALID_NP(conv)); + bc_num_mul(&conv, &vm.max, &temp1, 0); bc_num_bigdig2num(&conv, (BcBigDig) s1); bc_num_add(&conv, &temp1, &temp2, 0); - bc_num_div(&temp2, &pow, &temp3, BC_RAND_STATE_BITS); + bc_num_div(&temp2, &vm.max2, &temp3, BC_RAND_STATE_BITS); bc_num_bigdig2num(&conv, (BcBigDig) i2); + assert(BC_NUM_RDX_VALID_NP(conv)); + bc_num_mul(&conv, &vm.max, &temp1, 0); bc_num_bigdig2num(&conv, (BcBigDig) i1); @@ -2321,6 +2401,8 @@ void bc_num_createFromRNG(BcNum *restrict n, BcRNG *rng) { bc_num_add(&temp2, &temp3, n, 0); + assert(BC_NUM_RDX_VALID(n)); + err: BC_SIG_MAYLOCK; bc_num_free(&temp3); @@ -2340,8 +2422,8 @@ void bc_num_irand(const BcNum *restrict a, BcNum *restrict b, assert(a != b); - if (BC_ERR(a->neg)) bc_vm_err(BC_ERROR_MATH_NEGATIVE); - if (BC_ERR(a->rdx)) bc_vm_err(BC_ERROR_MATH_NON_INTEGER); + if (BC_ERR(BC_NUM_NEG(a))) bc_vm_err(BC_ERR_MATH_NEGATIVE); + if (BC_ERR(BC_NUM_RDX_VAL(a))) bc_vm_err(BC_ERR_MATH_NON_INTEGER); if (BC_NUM_ZERO(a) || BC_NUM_ONE(a)) return; cmp = bc_num_cmp(a, &vm.max); @@ -2396,8 +2478,7 @@ void bc_num_irand(const BcNum *restrict a, BcNum *restrict b, c2 = &cp2; // This assert is here because it has to be true. It is also here to justify - // the use of BC_ERROR_SIGNAL_ONLY() on each of the divmod's and mod's - // below. + // the use of BC_ERR_SIGNAL_ONLY() on each of the divmod's and mod's below. assert(BC_NUM_NONZERO(&vm.max)); while (BC_NUM_NONZERO(c1)) { @@ -2429,11 +2510,17 @@ void bc_num_irand(const BcNum *restrict a, BcNum *restrict b, bc_num_bigdig2num(&rand, r); + assert(BC_NUM_RDX_VALID_NP(rand)); + assert(BC_NUM_RDX_VALID(p1)); + bc_num_mul(&rand, p1, p2, 0); bc_num_add(p2, t1, t2, 0); if (BC_NUM_NONZERO(c2)) { + assert(BC_NUM_RDX_VALID_NP(vm.max)); + assert(BC_NUM_RDX_VALID(p1)); + bc_num_mul(&vm.max, p1, p2, 0); tmp = p1; @@ -2454,6 +2541,8 @@ void bc_num_irand(const BcNum *restrict a, BcNum *restrict b, bc_num_copy(b, t1); bc_num_clean(b); + assert(BC_NUM_RDX_VALID(b)); + err: BC_SIG_MAYLOCK; bc_num_free(&pow); @@ -2473,11 +2562,11 @@ size_t bc_num_addReq(const BcNum *a, const BcNum *b, size_t scale) { BC_UNUSED(scale); - ardx = a->rdx; + ardx = BC_NUM_RDX_VAL(a); aint = bc_num_int(a); assert(aint <= a->len && ardx <= a->len); - brdx = b->rdx; + brdx = BC_NUM_RDX_VAL(b); bint = bc_num_int(b); assert(bint <= b->len && brdx <= b->len); @@ -2489,13 +2578,22 @@ size_t bc_num_addReq(const BcNum *a, const BcNum *b, size_t scale) { size_t bc_num_mulReq(const BcNum *a, const BcNum *b, size_t scale) { size_t max, rdx; - rdx = bc_vm_growSize(a->rdx, b->rdx); + rdx = bc_vm_growSize(BC_NUM_RDX_VAL(a), BC_NUM_RDX_VAL(b)); max = BC_NUM_RDX(scale); max = bc_vm_growSize(BC_MAX(max, rdx), 1); rdx = bc_vm_growSize(bc_vm_growSize(bc_num_int(a), bc_num_int(b)), max); return rdx; } +size_t bc_num_divReq(const BcNum *a, const BcNum *b, size_t scale) { + size_t max, rdx; + rdx = bc_vm_growSize(BC_NUM_RDX_VAL(a), BC_NUM_RDX_VAL(b)); + max = BC_NUM_RDX(scale); + max = bc_vm_growSize(BC_MAX(max, rdx), 1); + rdx = bc_vm_growSize(bc_num_int(a), max); + return rdx; +} + size_t bc_num_powReq(const BcNum *a, const BcNum *b, size_t scale) { BC_UNUSED(scale); return bc_vm_growSize(bc_vm_growSize(a->len, b->len), 1); @@ -2504,44 +2602,62 @@ size_t bc_num_powReq(const BcNum *a, const BcNum *b, size_t scale) { #if BC_ENABLE_EXTRA_MATH size_t bc_num_placesReq(const BcNum *a, const BcNum *b, size_t scale) { BC_UNUSED(scale); - return a->len + b->len - a->rdx - b->rdx; + return a->len + b->len - BC_NUM_RDX_VAL(a) - BC_NUM_RDX_VAL(b); } #endif // BC_ENABLE_EXTRA_MATH void bc_num_add(BcNum *a, BcNum *b, BcNum *c, size_t scale) { + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); bc_num_binary(a, b, c, false, bc_num_as, bc_num_addReq(a, b, scale)); } void bc_num_sub(BcNum *a, BcNum *b, BcNum *c, size_t scale) { + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); bc_num_binary(a, b, c, true, bc_num_as, bc_num_addReq(a, b, scale)); } void bc_num_mul(BcNum *a, BcNum *b, BcNum *c, size_t scale) { + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); bc_num_binary(a, b, c, scale, bc_num_m, bc_num_mulReq(a, b, scale)); } void bc_num_div(BcNum *a, BcNum *b, BcNum *c, size_t scale) { - bc_num_binary(a, b, c, scale, bc_num_d, bc_num_mulReq(a, b, scale)); + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); + bc_num_binary(a, b, c, scale, bc_num_d, bc_num_divReq(a, b, scale)); } void bc_num_mod(BcNum *a, BcNum *b, BcNum *c, size_t scale) { - bc_num_binary(a, b, c, scale, bc_num_rem, bc_num_mulReq(a, b, scale)); + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); + bc_num_binary(a, b, c, scale, bc_num_rem, bc_num_divReq(a, b, scale)); } void bc_num_pow(BcNum *a, BcNum *b, BcNum *c, size_t scale) { + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); bc_num_binary(a, b, c, scale, bc_num_p, bc_num_powReq(a, b, scale)); } #if BC_ENABLE_EXTRA_MATH void bc_num_places(BcNum *a, BcNum *b, BcNum *c, size_t scale) { + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); bc_num_binary(a, b, c, scale, bc_num_place, bc_num_placesReq(a, b, scale)); } void bc_num_lshift(BcNum *a, BcNum *b, BcNum *c, size_t scale) { + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); bc_num_binary(a, b, c, scale, bc_num_left, bc_num_placesReq(a, b, scale)); } void bc_num_rshift(BcNum *a, BcNum *b, BcNum *c, size_t scale) { + assert(BC_NUM_RDX_VALID(a)); + assert(BC_NUM_RDX_VALID(b)); bc_num_binary(a, b, c, scale, bc_num_right, bc_num_placesReq(a, b, scale)); } #endif // BC_ENABLE_EXTRA_MATH @@ -2554,13 +2670,13 @@ void bc_num_sqrt(BcNum *restrict a, BcNum *restrict b, size_t scale) { assert(a != NULL && b != NULL && a != b); - if (BC_ERR(a->neg)) bc_vm_err(BC_ERROR_MATH_NEGATIVE); + if (BC_ERR(BC_NUM_NEG(a))) bc_vm_err(BC_ERR_MATH_NEGATIVE); if (a->scale > scale) scale = a->scale; len = bc_vm_growSize(bc_num_intDigits(a), 1); rdx = BC_NUM_RDX(scale); - req = bc_vm_growSize(BC_MAX(rdx, a->rdx), len >> 1); + req = bc_vm_growSize(BC_MAX(rdx, BC_NUM_RDX_VAL(a)), len >> 1); BC_SIG_LOCK; @@ -2568,6 +2684,9 @@ void bc_num_sqrt(BcNum *restrict a, BcNum *restrict b, size_t scale) { BC_SIG_UNLOCK; + assert(a != NULL && b != NULL && a != b); + assert(a->num != NULL && b->num != NULL); + if (BC_NUM_ZERO(a)) { bc_num_setToZero(b, scale); return; @@ -2579,7 +2698,7 @@ void bc_num_sqrt(BcNum *restrict a, BcNum *restrict b, size_t scale) { } rdx = BC_NUM_RDX(scale); - rdx = BC_MAX(rdx, a->rdx); + rdx = BC_MAX(rdx, BC_NUM_RDX_VAL(a)); len = bc_vm_growSize(a->len, rdx); BC_SIG_LOCK; @@ -2591,7 +2710,7 @@ void bc_num_sqrt(BcNum *restrict a, BcNum *restrict b, size_t scale) { bc_num_one(&half); half.num[0] = BC_BASE_POW / 2; half.len = 1; - half.rdx = 1; + BC_NUM_RDX_SET_NP(half, 1); half.scale = 1; bc_num_init(&f, len); @@ -2616,6 +2735,7 @@ void bc_num_sqrt(BcNum *restrict a, BcNum *restrict b, size_t scale) { bc_num_shiftLeft(x0, pow / 2); } + // I can set the rdx here directly because neg should be false. x0->scale = x0->rdx = digs = digs1 = digs2 = 0; resscale = (scale + BC_BASE_DIGS) + 2; @@ -2625,6 +2745,10 @@ void bc_num_sqrt(BcNum *restrict a, BcNum *restrict b, size_t scale) { bc_num_div(a, x0, &f, resscale); bc_num_add(x0, &f, &fprime, resscale); + + assert(BC_NUM_RDX_VALID_NP(fprime)); + assert(BC_NUM_RDX_VALID_NP(half)); + bc_num_mul(&fprime, &half, x1, resscale); temp = x0; @@ -2635,9 +2759,10 @@ void bc_num_sqrt(BcNum *restrict a, BcNum *restrict b, size_t scale) { bc_num_copy(b, x0); if (b->scale > scale) bc_num_truncate(b, b->scale - scale); - assert(!b->neg || BC_NUM_NONZERO(b)); - assert(b->rdx <= b->len || !b->len); - assert(!b->len || b->num[b->len - 1] || b->rdx == b->len); + assert(!BC_NUM_NEG(b) || BC_NUM_NONZERO(b)); + assert(BC_NUM_RDX_VALID(b)); + assert(BC_NUM_RDX_VAL(b) <= b->len || !b->len); + assert(!b->len || b->num[b->len - 1] || BC_NUM_RDX_VAL(b) == b->len); err: BC_SIG_MAYLOCK; @@ -2650,9 +2775,9 @@ err: void bc_num_divmod(BcNum *a, BcNum *b, BcNum *c, BcNum *d, size_t scale) { - BcNum num2, *ptr_a; - bool init = false; size_t ts, len; + BcNum *ptr_a, num2; + bool init = false; ts = BC_MAX(scale + b->scale, a->scale); len = bc_num_mulReq(a, b, ts); @@ -2680,8 +2805,9 @@ void bc_num_divmod(BcNum *a, BcNum *b, BcNum *c, BcNum *d, size_t scale) { bc_num_expand(c, len); } - if (BC_NUM_NONZERO(a) && !a->rdx && !b->rdx && b->len == 1 && !scale) { - + if (BC_NUM_NONZERO(a) && !BC_NUM_RDX_VAL(a) && + !BC_NUM_RDX_VAL(b) && b->len == 1 && !scale) + { BcBigDig rem; bc_num_divArray(ptr_a, (BcBigDig) b->num[0], c, &rem); @@ -2693,12 +2819,14 @@ void bc_num_divmod(BcNum *a, BcNum *b, BcNum *c, BcNum *d, size_t scale) { } else bc_num_r(ptr_a, b, c, d, scale, ts); - assert(!c->neg || BC_NUM_NONZERO(c)); - assert(c->rdx <= c->len || !c->len); - assert(!c->len || c->num[c->len - 1] || c->rdx == c->len); - assert(!d->neg || BC_NUM_NONZERO(d)); - assert(d->rdx <= d->len || !d->len); - assert(!d->len || d->num[d->len - 1] || d->rdx == d->len); + assert(!BC_NUM_NEG(c) || BC_NUM_NONZERO(c)); + assert(BC_NUM_RDX_VALID(c)); + assert(BC_NUM_RDX_VAL(c) <= c->len || !c->len); + assert(!c->len || c->num[c->len - 1] || BC_NUM_RDX_VAL(c) == c->len); + assert(!BC_NUM_NEG(d) || BC_NUM_NONZERO(d)); + assert(BC_NUM_RDX_VALID(d)); + assert(BC_NUM_RDX_VAL(d) <= d->len || !d->len); + assert(!d->len || d->num[d->len - 1] || BC_NUM_RDX_VAL(d) == d->len); err: if (init) { @@ -2717,10 +2845,10 @@ void bc_num_modexp(BcNum *a, BcNum *b, BcNum *c, BcNum *restrict d) { assert(a != NULL && b != NULL && c != NULL && d != NULL); assert(a != d && b != d && c != d); - if (BC_ERR(BC_NUM_ZERO(c))) bc_vm_err(BC_ERROR_MATH_DIVIDE_BY_ZERO); - if (BC_ERR(b->neg)) bc_vm_err(BC_ERROR_MATH_NEGATIVE); - if (BC_ERR(a->rdx || b->rdx || c->rdx)) - bc_vm_err(BC_ERROR_MATH_NON_INTEGER); + if (BC_ERR(BC_NUM_ZERO(c))) bc_vm_err(BC_ERR_MATH_DIVIDE_BY_ZERO); + if (BC_ERR(BC_NUM_NEG(b))) bc_vm_err(BC_ERR_MATH_NEGATIVE); + if (BC_ERR(BC_NUM_RDX_VAL(a) || BC_NUM_RDX_VAL(b) || BC_NUM_RDX_VAL(c))) + bc_vm_err(BC_ERR_MATH_NON_INTEGER); bc_num_expand(d, c->len); @@ -2747,7 +2875,10 @@ void bc_num_modexp(BcNum *a, BcNum *b, BcNum *c, BcNum *restrict d) { // Num two cannot be 0, so no errors. bc_num_divmod(&exp, &two, &exp, &temp, 0); - if (BC_NUM_ONE(&temp) && !temp.neg) { + if (BC_NUM_ONE(&temp) && !BC_NUM_NEG_NP(temp)) { + + assert(BC_NUM_RDX_VALID(d)); + assert(BC_NUM_RDX_VALID_NP(base)); bc_num_mul(d, &base, &temp, 0); @@ -2755,6 +2886,8 @@ void bc_num_modexp(BcNum *a, BcNum *b, BcNum *c, BcNum *restrict d) { bc_num_rem(&temp, c, d, 0); } + assert(BC_NUM_RDX_VALID_NP(base)); + bc_num_mul(&base, &base, &temp, 0); // We already checked for 0. @@ -2767,8 +2900,9 @@ err: bc_num_free(&temp); bc_num_free(&base); BC_LONGJMP_CONT; - assert(!d->neg || d->len); - assert(!d->len || d->num[d->len - 1] || d->rdx == d->len); + assert(!BC_NUM_NEG(d) || d->len); + assert(BC_NUM_RDX_VALID(d)); + assert(!d->len || d->num[d->len - 1] || BC_NUM_RDX_VAL(d) == d->len); } #endif // DC_ENABLED @@ -2797,7 +2931,7 @@ void bc_num_printDigs(const BcDig *n, size_t len, bool emptyline) { void bc_num_printWithDigs(const BcNum *n, const char *name, bool emptyline) { bc_file_puts(&vm.fout, name); bc_file_printf(&vm.fout, " len: %zu, rdx: %zu, scale: %zu\n", - name, n->len, n->rdx, n->scale); + name, n->len, BC_NUM_RDX_VAL(n), n->scale); bc_num_printDigs(n->num, n->len, emptyline); } @@ -2806,13 +2940,13 @@ void bc_num_dump(const char *varname, const BcNum *n) { ulong i, scale = n->scale; bc_file_printf(&vm.ferr, "\n%s = %s", varname, - n->len ? (n->neg ? "-" : "+") : "0 "); + n->len ? (BC_NUM_NEG(n) ? "-" : "+") : "0 "); for (i = n->len - 1; i < n->len; --i) { - if (i + 1 == n->rdx) bc_file_puts(&vm.ferr, ". "); + if (i + 1 == BC_NUM_RDX_VAL(n)) bc_file_puts(&vm.ferr, ". "); - if (scale / BC_BASE_DIGS != n->rdx - i - 1) + if (scale / BC_BASE_DIGS != BC_NUM_RDX_VAL(n) - i - 1) bc_file_printf(&vm.ferr, "%lu ", (unsigned long) n->num[i]); else { @@ -2831,7 +2965,7 @@ void bc_num_dump(const char *varname, const BcNum *n) { } bc_file_printf(&vm.ferr, "(%zu | %zu.%zu / %zu) %lu\n", - n->scale, n->len, n->rdx, n->cap, + n->scale, n->len, BC_NUM_RDX_VAL(n), n->cap, (unsigned long) (void*) n->num); } #endif // BC_DEBUG_CODE diff --git a/contrib/bc/src/opt.c b/contrib/bc/src/opt.c index 3a01a2657f15..57cee759af5e 100644 --- a/contrib/bc/src/opt.c +++ b/contrib/bc/src/opt.c @@ -62,8 +62,8 @@ static const char* bc_opt_longopt(const BcOptLong *longopts, int c) { return "NULL"; } -static void bc_opt_error(BcError err, int c, const char *str) { - if (err == BC_ERROR_FATAL_OPTION) bc_vm_error(err, 0, str); +static void bc_opt_error(BcErr err, int c, const char *str) { + if (err == BC_ERR_FATAL_OPTION) bc_vm_error(err, 0, str); else bc_vm_error(err, 0, (int) c, str); } @@ -110,10 +110,12 @@ static int bc_opt_parseShort(BcOpt *o, const BcOptLong *longopts) { str[0] = option[0]; o->optind += 1; - bc_opt_error(BC_ERROR_FATAL_OPTION, option[0], str); + bc_opt_error(BC_ERR_FATAL_OPTION, option[0], str); } } // Fallthrough. + BC_FALLTHROUGH + case BC_OPT_NONE: { if (option[1]) o->subopt += 1; @@ -136,7 +138,7 @@ static int bc_opt_parseShort(BcOpt *o, const BcOptLong *longopts) { o->optarg = next; o->optind += 1; } - else bc_opt_error(BC_ERROR_FATAL_OPTION_NO_ARG, option[0], + else bc_opt_error(BC_ERR_FATAL_OPTION_NO_ARG, option[0], bc_opt_longopt(longopts, option[0])); @@ -215,12 +217,12 @@ int bc_opt_parse(BcOpt *o, const BcOptLong *longopts) { if ((longopts[i].type == BC_OPT_BC_ONLY && BC_IS_DC) || (longopts[i].type == BC_OPT_DC_ONLY && BC_IS_BC)) { - bc_opt_error(BC_ERROR_FATAL_OPTION, o->optopt, name); + bc_opt_error(BC_ERR_FATAL_OPTION, o->optopt, name); } if (longopts[i].type == BC_OPT_NONE && arg != NULL) { - bc_opt_error(BC_ERROR_FATAL_OPTION_ARG, o->optopt, name); + bc_opt_error(BC_ERR_FATAL_OPTION_ARG, o->optopt, name); } if (arg != NULL) o->optarg = arg; @@ -229,7 +231,7 @@ int bc_opt_parse(BcOpt *o, const BcOptLong *longopts) { o->optarg = o->argv[o->optind]; if (o->optarg != NULL) o->optind += 1; - else bc_opt_error(BC_ERROR_FATAL_OPTION_NO_ARG, + else bc_opt_error(BC_ERR_FATAL_OPTION_NO_ARG, o->optopt, name); } @@ -237,7 +239,7 @@ int bc_opt_parse(BcOpt *o, const BcOptLong *longopts) { } } - bc_opt_error(BC_ERROR_FATAL_OPTION, 0, option); + bc_opt_error(BC_ERR_FATAL_OPTION, 0, option); return -1; } diff --git a/contrib/bc/src/parse.c b/contrib/bc/src/parse.c index a48f5807e9ce..39b79efdd02f 100644 --- a/contrib/bc/src/parse.c +++ b/contrib/bc/src/parse.c @@ -40,9 +40,6 @@ #include <limits.h> -#include <status.h> -#include <vector.h> -#include <lex.h> #include <parse.h> #include <program.h> #include <vm.h> diff --git a/contrib/bc/src/program.c b/contrib/bc/src/program.c index 3c2544f8a61f..f0a67ee194c1 100644 --- a/contrib/bc/src/program.c +++ b/contrib/bc/src/program.c @@ -61,7 +61,7 @@ static inline void bc_program_type_num(BcResult *r, BcNum *n) { assert(r->t != BC_RESULT_VOID); #endif // BC_ENABLED - if (BC_ERR(!BC_PROG_NUM(r, n))) bc_vm_err(BC_ERROR_EXEC_TYPE); + if (BC_ERR(!BC_PROG_NUM(r, n))) bc_vm_err(BC_ERR_EXEC_TYPE); } #if BC_ENABLED @@ -72,7 +72,7 @@ static void bc_program_type_match(BcResult *r, BcType t) { #endif // DC_ENABLED if (BC_ERR((r->t != BC_RESULT_ARRAY) != (!t))) - bc_vm_err(BC_ERROR_EXEC_TYPE); + bc_vm_err(BC_ERR_EXEC_TYPE); } #endif // BC_ENABLED @@ -270,7 +270,7 @@ static void bc_program_operand(BcProgram *p, BcResult **r, *r = bc_vec_item_rev(&p->results, idx); #if BC_ENABLED - if (BC_ERR((*r)->t == BC_RESULT_VOID)) bc_vm_err(BC_ERROR_EXEC_VOID_VAL); + if (BC_ERR((*r)->t == BC_RESULT_VOID)) bc_vm_err(BC_ERR_EXEC_VOID_VAL); #endif // BC_ENABLED *n = bc_program_num(p, *r); @@ -286,7 +286,7 @@ static void bc_program_binPrep(BcProgram *p, BcResult **l, BcNum **ln, #ifndef BC_PROG_NO_STACK_CHECK if (BC_IS_DC) { if (BC_ERR(!BC_PROG_STACK(&p->results, idx + 2))) - bc_vm_err(BC_ERROR_EXEC_STACK); + bc_vm_err(BC_ERR_EXEC_STACK); } #endif // BC_PROG_NO_STACK_CHECK @@ -306,7 +306,7 @@ static void bc_program_binPrep(BcProgram *p, BcResult **l, BcNum **ln, if (lt == (*r)->t && (lt == BC_RESULT_VAR || lt == BC_RESULT_ARRAY_ELEM)) *ln = bc_program_num(p, *l); - if (BC_ERR(lt == BC_RESULT_STR)) bc_vm_err(BC_ERROR_EXEC_TYPE); + if (BC_ERR(lt == BC_RESULT_STR)) bc_vm_err(BC_ERR_EXEC_TYPE); } static void bc_program_binOpPrep(BcProgram *p, BcResult **l, BcNum **ln, @@ -329,7 +329,7 @@ static void bc_program_assignPrep(BcProgram *p, BcResult **l, BcNum **ln, lt = (*l)->t; if (BC_ERR(lt >= min && lt <= BC_RESULT_ONE)) - bc_vm_err(BC_ERROR_EXEC_TYPE); + bc_vm_err(BC_ERR_EXEC_TYPE); #if DC_ENABLED if(BC_IS_DC) { @@ -351,7 +351,7 @@ static void bc_program_prep(BcProgram *p, BcResult **r, BcNum **n, size_t idx) { #ifndef BC_PROG_NO_STACK_CHECK if (BC_IS_DC) { if (BC_ERR(!BC_PROG_STACK(&p->results, idx + 1))) - bc_vm_err(BC_ERROR_EXEC_STACK); + bc_vm_err(BC_ERR_EXEC_STACK); } #endif // BC_PROG_NO_STACK_CHECK @@ -391,7 +391,7 @@ static void bc_program_const(BcProgram *p, const char *code, size_t *bgn) { } // bc_num_parse() should only do operations that cannot fail. - bc_num_parse(&c->num, c->val, base, !c->val[1]); + bc_num_parse(&c->num, c->val, base); c->base = base; } @@ -419,6 +419,9 @@ static void bc_program_op(BcProgram *p, uchar inst) { BC_SIG_UNLOCK; + assert(BC_NUM_RDX_VALID(n1)); + assert(BC_NUM_RDX_VALID(n2)); + bc_program_ops[idx](n1, n2, &res->d.n, BC_PROG_SCALE(p)); bc_program_retire(p, 1, 2); @@ -437,7 +440,7 @@ static void bc_program_read(BcProgram *p) { for (i = 0; i < p->stack.len; ++i) { BcInstPtr *ip_ptr = bc_vec_item(&p->stack, i); if (ip_ptr->func == BC_PROG_READ) - bc_vm_err(BC_ERROR_EXEC_REC_READ); + bc_vm_err(BC_ERR_EXEC_REC_READ); } BC_SIG_LOCK; @@ -454,13 +457,13 @@ static void bc_program_read(BcProgram *p) { bc_vec_npop(&f->code, f->code.len); s = bc_read_line(&buf, BC_IS_BC ? "read> " : "?> "); - if (s == BC_STATUS_EOF) bc_vm_err(BC_ERROR_EXEC_READ_EXPR); + if (s == BC_STATUS_EOF) bc_vm_err(BC_ERR_EXEC_READ_EXPR); bc_parse_text(&parse, buf.v); vm.expr(&parse, BC_PARSE_NOREAD | BC_PARSE_NEEDVAL); if (BC_ERR(parse.l.t != BC_LEX_NLINE && parse.l.t != BC_LEX_EOF)) - bc_vm_err(BC_ERROR_EXEC_READ_EXPR); + bc_vm_err(BC_ERR_EXEC_READ_EXPR); #if BC_ENABLED if (BC_G) bc_program_prepGlobals(p); @@ -495,6 +498,12 @@ exec_err: static void bc_program_rand(BcProgram *p) { BcRand rand = bc_rand_int(&p->rng); bc_program_pushBigdig(p, (BcBigDig) rand, BC_RESULT_TEMP); +#ifndef NDEBUG + { + BcResult *r = bc_vec_top(&p->results); + assert(BC_NUM_RDX_VALID_NP(r->d.n)); + } +#endif // NDEBUG } #endif // BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND @@ -560,7 +569,7 @@ static void bc_program_print(BcProgram *p, uchar inst, size_t idx) { #ifndef BC_PROG_NO_STACK_CHECK if (BC_IS_DC) { if (BC_ERR(!BC_PROG_STACK(&p->results, idx + 1))) - bc_vm_err(BC_ERROR_EXEC_STACK); + bc_vm_err(BC_ERR_EXEC_STACK); } #endif // BC_PROG_NO_STACK_CHECK @@ -570,7 +579,7 @@ static void bc_program_print(BcProgram *p, uchar inst, size_t idx) { #if BC_ENABLED if (r->t == BC_RESULT_VOID) { - if (BC_ERR(pop)) bc_vm_err(BC_ERROR_EXEC_VOID_VAL); + if (BC_ERR(pop)) bc_vm_err(BC_ERR_EXEC_VOID_VAL); bc_vec_pop(&p->results); return; } @@ -604,7 +613,7 @@ static void bc_program_print(BcProgram *p, uchar inst, size_t idx) { void bc_program_negate(BcResult *r, BcNum *n) { bc_num_copy(&r->d.n, n); - if (BC_NUM_NONZERO(&r->d.n)) r->d.n.neg = !r->d.n.neg; + if (BC_NUM_NONZERO(&r->d.n)) BC_NUM_NEG_TGL_NP(r->d.n); } void bc_program_not(BcResult *r, BcNum *n) { @@ -743,7 +752,7 @@ static void bc_program_copyToVar(BcProgram *p, size_t idx, if (BC_IS_DC) { if (BC_ERR(!BC_PROG_STACK(&p->results, 1))) - bc_vm_err(BC_ERROR_EXEC_STACK); + bc_vm_err(BC_ERR_EXEC_STACK); assert(BC_PROG_STACK(&p->results, 1)); @@ -768,7 +777,7 @@ static void bc_program_copyToVar(BcProgram *p, size_t idx, #if DC_ENABLED if (BC_IS_DC && (ptr->t == BC_RESULT_STR || BC_PROG_STR(n))) { - if (BC_ERR(!var)) bc_vm_err(BC_ERROR_EXEC_TYPE); + if (BC_ERR(!var)) bc_vm_err(BC_ERR_EXEC_TYPE); bc_program_assignStr(p, ptr, vec, true); return; } @@ -871,6 +880,9 @@ static void bc_program_assign(BcProgram *p, uchar inst) { if (!use_val) inst -= (BC_INST_ASSIGN_POWER_NO_VAL - BC_INST_ASSIGN_POWER); + assert(BC_NUM_RDX_VALID(l)); + assert(BC_NUM_RDX_VALID(r)); + bc_program_ops[inst - BC_INST_ASSIGN_POWER](l, r, l, scale); } #endif // BC_ENABLED @@ -882,10 +894,10 @@ static void bc_program_assign(BcProgram *p, uchar inst) { BcVec *v; BcBigDig *ptr, *ptr_t, val, max, min; - BcError e; + BcErr e; bc_num_bigdig(l, &val); - e = left->t - BC_RESULT_IBASE + BC_ERROR_EXEC_IBASE; + e = left->t - BC_RESULT_IBASE + BC_ERR_EXEC_IBASE; if (sc) { min = 0; @@ -940,7 +952,7 @@ static void bc_program_pushVar(BcProgram *p, const char *restrict code, BcVec *v = bc_program_vec(p, idx, BC_TYPE_VAR); BcNum *num = bc_vec_top(v); - if (BC_ERR(!BC_PROG_STACK(v, 2 - copy))) bc_vm_err(BC_ERROR_EXEC_STACK); + if (BC_ERR(!BC_PROG_STACK(v, 2 - copy))) bc_vm_err(BC_ERR_EXEC_STACK); assert(BC_PROG_STACK(v, 2 - copy)); @@ -1058,9 +1070,9 @@ static void bc_program_call(BcProgram *p, const char *restrict code, ip.func = bc_program_index(code, idx); f = bc_vec_item(&p->fns, ip.func); - if (BC_ERR(!f->code.len)) bc_vm_verr(BC_ERROR_EXEC_UNDEF_FUNC, f->name); + if (BC_ERR(!f->code.len)) bc_vm_verr(BC_ERR_EXEC_UNDEF_FUNC, f->name); if (BC_ERR(nparams != f->nparams)) - bc_vm_verr(BC_ERROR_EXEC_PARAMS, f->nparams, nparams); + bc_vm_verr(BC_ERR_EXEC_PARAMS, f->nparams, nparams); ip.len = p->results.len - nparams; assert(BC_PROG_STACK(&p->results, nparams)); @@ -1073,8 +1085,7 @@ static void bc_program_call(BcProgram *p, const char *restrict code, bool last = true; arg = bc_vec_top(&p->results); - if (BC_ERR(arg->t == BC_RESULT_VOID)) - bc_vm_err(BC_ERROR_EXEC_VOID_VAL); + if (BC_ERR(arg->t == BC_RESULT_VOID)) bc_vm_err(BC_ERR_EXEC_VOID_VAL); a = bc_vec_item(&f->autos, nparams - 1 - i); @@ -1178,7 +1189,7 @@ static void bc_program_builtin(BcProgram *p, uchar inst) { #ifndef BC_PROG_NO_STACK_CHECK if (BC_IS_DC) { if (BC_ERR(!BC_PROG_STACK(&p->results, 1))) - bc_vm_err(BC_ERROR_EXEC_STACK); + bc_vm_err(BC_ERR_EXEC_STACK); } #endif // BC_PROG_NO_STACK_CHECK @@ -1203,7 +1214,7 @@ static void bc_program_builtin(BcProgram *p, uchar inst) { BC_SIG_UNLOCK; - res->d.n.neg = false; + BC_NUM_NEG_CLR_NP(res->d.n); } #if BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND else if (inst == BC_INST_IRAND) { @@ -1271,7 +1282,7 @@ static void bc_program_divmod(BcProgram *p) { BcNum *n1, *n2; size_t req; - bc_vec_expand(&p->results, p->results.len + 2); + bc_vec_grow(&p->results, 2); // We don't need to update the pointer because // the capacity is enough due to the line above. @@ -1299,7 +1310,7 @@ static void bc_program_modexp(BcProgram *p) { BcResult *r1, *r2, *r3, *res; BcNum *n1, *n2, *n3; - if (BC_ERR(!BC_PROG_STACK(&p->results, 3))) bc_vm_err(BC_ERROR_EXEC_STACK); + if (BC_ERR(!BC_PROG_STACK(&p->results, 3))) bc_vm_err(BC_ERR_EXEC_STACK); assert(BC_PROG_STACK(&p->results, 3)); @@ -1346,7 +1357,7 @@ static uchar bc_program_asciifyNum(BcProgram *p, BcNum *n) { BC_SIG_UNLOCK; bc_num_truncate(&num, num.scale); - num.neg = false; + BC_NUM_NEG_CLR_NP(num); // This is guaranteed to not have a divide by 0 // because strmb is equal to UCHAR_MAX + 1. @@ -1372,7 +1383,7 @@ static void bc_program_asciify(BcProgram *p) { uchar c; size_t idx; - if (BC_ERR(!BC_PROG_STACK(&p->results, 1))) bc_vm_err(BC_ERROR_EXEC_STACK); + if (BC_ERR(!BC_PROG_STACK(&p->results, 1))) bc_vm_err(BC_ERR_EXEC_STACK); assert(BC_PROG_STACK(&p->results, 1)); @@ -1409,7 +1420,7 @@ static void bc_program_printStream(BcProgram *p) { BcResult *r; BcNum *n; - if (BC_ERR(!BC_PROG_STACK(&p->results, 1))) bc_vm_err(BC_ERROR_EXEC_STACK); + if (BC_ERR(!BC_PROG_STACK(&p->results, 1))) bc_vm_err(BC_ERR_EXEC_STACK); assert(BC_PROG_STACK(&p->results, 1)); @@ -1471,7 +1482,7 @@ static void bc_program_execStr(BcProgram *p, const char *restrict code, assert(p->stack.len == p->tail_calls.len); - if (BC_ERR(!BC_PROG_STACK(&p->results, 1))) bc_vm_err(BC_ERROR_EXEC_STACK); + if (BC_ERR(!BC_PROG_STACK(&p->results, 1))) bc_vm_err(BC_ERR_EXEC_STACK); assert(BC_PROG_STACK(&p->results, 1)); @@ -1496,7 +1507,7 @@ static void bc_program_execStr(BcProgram *p, const char *restrict code, n = bc_vec_top(bc_program_vec(p, idx, BC_TYPE_VAR)); else goto exit; - if (BC_ERR(!BC_PROG_STR(n))) bc_vm_err(BC_ERROR_EXEC_TYPE); + if (BC_ERR(!BC_PROG_STR(n))) bc_vm_err(BC_ERR_EXEC_TYPE); BC_UNSETJMP; BC_SIG_UNLOCK; @@ -1832,6 +1843,8 @@ void bc_program_exec(BcProgram *p) { bc_vec_pop(&p->results); } // Fallthrough. + BC_FALLTHROUGH + case BC_INST_JUMP: { idx = bc_program_index(code, &ip->idx); @@ -2077,7 +2090,7 @@ void bc_program_exec(BcProgram *p) { #ifndef BC_PROG_NO_STACK_CHECK if (!BC_IS_BC) { if (BC_ERR(!BC_PROG_STACK(&p->results, 1))) - bc_vm_err(BC_ERROR_EXEC_STACK); + bc_vm_err(BC_ERR_EXEC_STACK); } #endif // BC_PROG_NO_STACK_CHECK @@ -2145,7 +2158,7 @@ void bc_program_exec(BcProgram *p) { case BC_INST_DUPLICATE: { if (BC_ERR(!BC_PROG_STACK(&p->results, 1))) - bc_vm_err(BC_ERROR_EXEC_STACK); + bc_vm_err(BC_ERR_EXEC_STACK); assert(BC_PROG_STACK(&p->results, 1)); @@ -2166,7 +2179,7 @@ void bc_program_exec(BcProgram *p) { BcResult *ptr2; if (BC_ERR(!BC_PROG_STACK(&p->results, 2))) - bc_vm_err(BC_ERROR_EXEC_STACK); + bc_vm_err(BC_ERR_EXEC_STACK); assert(BC_PROG_STACK(&p->results, 2)); diff --git a/contrib/bc/src/rand/rand.c b/contrib/bc/src/rand.c index b16061d711a1..a66728246fbc 100644 --- a/contrib/bc/src/rand/rand.c +++ b/contrib/bc/src/rand.c @@ -74,7 +74,6 @@ #include <unistd.h> #include <status.h> -#include <num.h> #include <rand.h> #include <vm.h> @@ -180,7 +179,7 @@ static ulong bc_rand_frand(void *ptr) { nread = read(fd, buf, sizeof(ulong)); - if (BC_ERR(nread != sizeof(ulong))) bc_vm_err(BC_ERROR_FATAL_IO_ERR); + if (BC_ERR(nread != sizeof(ulong))) bc_vm_err(BC_ERR_FATAL_IO_ERR); return *((ulong*) buf); } @@ -278,7 +277,7 @@ static void bc_rand_seedZeroes(BcRNG *r, BcRNGData *rng, size_t idx) { } } -static void bc_rand_srand(BcRNGData *rng) { +void bc_rand_srand(BcRNGData *rng) { int fd; diff --git a/contrib/bc/src/read.c b/contrib/bc/src/read.c index 6886a7e13602..45e868c927da 100644 --- a/contrib/bc/src/read.c +++ b/contrib/bc/src/read.c @@ -143,7 +143,7 @@ BcStatus bc_read_chars(BcVec *vec, const char *prompt) { BC_SIG_UNLOCK; - bc_vm_err(BC_ERROR_FATAL_IO_ERR); + bc_vm_err(BC_ERR_FATAL_IO_ERR); } BC_SIG_UNLOCK; @@ -177,14 +177,14 @@ BcStatus bc_read_line(BcVec *vec, const char *prompt) { #endif // BC_ENABLE_HISTORY if (BC_ERR(bc_read_binary(vec->v, vec->len - 1))) - bc_vm_verr(BC_ERROR_FATAL_BIN_FILE, bc_program_stdin_name); + bc_vm_verr(BC_ERR_FATAL_BIN_FILE, bc_program_stdin_name); return s; } void bc_read_file(const char *path, char **buf) { - BcError e = BC_ERROR_FATAL_IO_ERR; + BcErr e = BC_ERR_FATAL_IO_ERR; size_t size, r; struct stat pstat; int fd; @@ -194,11 +194,11 @@ void bc_read_file(const char *path, char **buf) { assert(path != NULL); fd = open(path, O_RDONLY); - if (BC_ERR(fd < 0)) bc_vm_verr(BC_ERROR_FATAL_FILE_ERR, path); + if (BC_ERR(fd < 0)) bc_vm_verr(BC_ERR_FATAL_FILE_ERR, path); if (BC_ERR(fstat(fd, &pstat) == -1)) goto malloc_err; if (BC_ERR(S_ISDIR(pstat.st_mode))) { - e = BC_ERROR_FATAL_PATH_DIR; + e = BC_ERR_FATAL_PATH_DIR; goto malloc_err; } @@ -211,7 +211,7 @@ void bc_read_file(const char *path, char **buf) { (*buf)[size] = '\0'; if (BC_ERR(bc_read_binary(*buf, size))) { - e = BC_ERROR_FATAL_BIN_FILE; + e = BC_ERR_FATAL_BIN_FILE; goto read_err; } diff --git a/contrib/bc/src/vector.c b/contrib/bc/src/vector.c index f45bcb198a25..df6936aaeb76 100644 --- a/contrib/bc/src/vector.c +++ b/contrib/bc/src/vector.c @@ -37,12 +37,11 @@ #include <stdlib.h> #include <string.h> -#include <status.h> #include <vector.h> #include <lang.h> #include <vm.h> -static void bc_vec_grow(BcVec *restrict v, size_t n) { +void bc_vec_grow(BcVec *restrict v, size_t n) { size_t len, cap = v->cap; sig_atomic_t lock; diff --git a/contrib/bc/src/vm.c b/contrib/bc/src/vm.c index e15b1398734e..3922b088414f 100644 --- a/contrib/bc/src/vm.c +++ b/contrib/bc/src/vm.c @@ -56,13 +56,15 @@ #endif // _WIN32 -#include <status.h> #include <vector.h> #include <args.h> #include <vm.h> #include <read.h> #include <bc.h> +char output_bufs[BC_VM_BUF_SIZE]; +BcVm vm; + #if BC_DEBUG_CODE BC_NORETURN void bc_vm_jmp(const char* f) { #else // BC_DEBUG_CODE @@ -84,12 +86,14 @@ BC_NORETURN void bc_vm_jmp(void) { assert(vm.jmp_bufs.len - (size_t) vm.sig_pop); #endif // NDEBUG + if (vm.jmp_bufs.len == 0) abort(); if (vm.sig_pop) bc_vec_pop(&vm.jmp_bufs); else vm.sig_pop = 1; siglongjmp(*((sigjmp_buf*) bc_vec_top(&vm.jmp_bufs)), 1); } +#if !BC_ENABLE_LIBRARY static void bc_vm_sig(int sig) { // There is already a signal in flight. @@ -132,8 +136,28 @@ void bc_vm_info(const char* const help) { bc_file_flush(&vm.fout); } +#endif // !BC_ENABLE_LIBRARY + +#if BC_ENABLE_LIBRARY +void bc_vm_handleError(BcErr e) { + + assert(e < BC_ERR_NELEMS); + assert(!vm.sig_pop); + + BC_SIG_LOCK; -void bc_vm_error(BcError e, size_t line, ...) { + if (e <= BC_ERR_MATH_DIVIDE_BY_ZERO) { + vm.err = (BclError) (e - BC_ERR_MATH_NEGATIVE + + BCL_ERROR_MATH_NEGATIVE); + } + else if (vm.abrt) abort(); + else if (e == BC_ERR_FATAL_ALLOC_ERR) vm.err = BCL_ERROR_FATAL_ALLOC_ERR; + else vm.err = BCL_ERROR_FATAL_UNKNOWN_ERR; + + BC_VM_JMP; +} +#else // BC_ENABLE_LIBRARY +void bc_vm_handleError(BcErr e, size_t line, ...) { BcStatus s; va_list args; @@ -141,11 +165,11 @@ void bc_vm_error(BcError e, size_t line, ...) { const char* err_type = vm.err_ids[id]; sig_atomic_t lock; - assert(e < BC_ERROR_NELEMS); + assert(e < BC_ERR_NELEMS); assert(!vm.sig_pop); #if BC_ENABLED - if (!BC_S && e >= BC_ERROR_POSIX_START) { + if (!BC_S && e >= BC_ERR_POSIX_START) { if (BC_W) { // Make sure to not return an error. id = UCHAR_MAX; @@ -261,7 +285,7 @@ static void bc_vm_envArgs(const char* const env_args_name) { buf += 1; start = buf; } - else if (instr) bc_vm_error(BC_ERROR_FATAL_OPTION, 0, start); + else if (instr) bc_vm_error(BC_ERR_FATAL_OPTION, 0, start); } else buf += 1; } @@ -293,6 +317,7 @@ static size_t bc_vm_envLen(const char *var) { return len; } +#endif // BC_ENABLE_LIBRARY void bc_vm_shutdown(void) { @@ -308,6 +333,7 @@ void bc_vm_shutdown(void) { #endif // BC_ENABLE_HISTORY #ifndef NDEBUG +#if !BC_ENABLE_LIBRARY bc_vec_free(&vm.env_args); free(vm.env_args_buffer); bc_vec_free(&vm.files); @@ -315,31 +341,40 @@ void bc_vm_shutdown(void) { bc_program_free(&vm.prog); bc_parse_free(&vm.prs); +#endif // !BC_ENABLE_LIBRARY - { - size_t i; - for (i = 0; i < vm.temps.len; ++i) - free(((BcNum*) bc_vec_item(&vm.temps, i))->num); - - bc_vec_free(&vm.temps); - } + bc_vm_freeTemps(); + bc_vec_free(&vm.temps); #endif // NDEBUG +#if !BC_ENABLE_LIBRARY bc_file_free(&vm.fout); bc_file_free(&vm.ferr); +#endif // !BC_ENABLE_LIBRARY } +#if !defined(NDEBUG) || BC_ENABLE_LIBRARY +void bc_vm_freeTemps(void) { + + size_t i; + + for (i = 0; i < vm.temps.len; ++i) { + free(((BcNum*) bc_vec_item(&vm.temps, i))->num); + } +} +#endif // !defined(NDEBUG) || BC_ENABLE_LIBRARY + inline size_t bc_vm_arraySize(size_t n, size_t size) { size_t res = n * size; if (BC_ERR(res >= SIZE_MAX || (n != 0 && res / n != size))) - bc_vm_err(BC_ERROR_FATAL_ALLOC_ERR); + bc_vm_err(BC_ERR_FATAL_ALLOC_ERR); return res; } inline size_t bc_vm_growSize(size_t a, size_t b) { size_t res = a + b; if (BC_ERR(res >= SIZE_MAX || res < a || res < b)) - bc_vm_err(BC_ERROR_FATAL_ALLOC_ERR); + bc_vm_err(BC_ERR_FATAL_ALLOC_ERR); return res; } @@ -351,7 +386,7 @@ void* bc_vm_malloc(size_t n) { ptr = malloc(n); - if (BC_ERR(ptr == NULL)) bc_vm_err(BC_ERROR_FATAL_ALLOC_ERR); + if (BC_ERR(ptr == NULL)) bc_vm_err(BC_ERR_FATAL_ALLOC_ERR); return ptr; } @@ -364,7 +399,7 @@ void* bc_vm_realloc(void *ptr, size_t n) { temp = realloc(ptr, n); - if (BC_ERR(temp == NULL)) bc_vm_err(BC_ERROR_FATAL_ALLOC_ERR); + if (BC_ERR(temp == NULL)) bc_vm_err(BC_ERR_FATAL_ALLOC_ERR); return temp; } @@ -377,11 +412,12 @@ char* bc_vm_strdup(const char *str) { s = strdup(str); - if (BC_ERR(!s)) bc_vm_err(BC_ERROR_FATAL_ALLOC_ERR); + if (BC_ERR(!s)) bc_vm_err(BC_ERR_FATAL_ALLOC_ERR); return s; } +#if !BC_ENABLE_LIBRARY void bc_vm_printf(const char *fmt, ...) { va_list args; @@ -396,12 +432,18 @@ void bc_vm_printf(const char *fmt, ...) { BC_SIG_UNLOCK; } +#endif // !BC_ENABLE_LIBRARY void bc_vm_putchar(int c) { +#if BC_ENABLE_LIBRARY + bc_vec_pushByte(&vm.out, (uchar) c); +#else // BC_ENABLE_LIBRARY bc_file_putchar(&vm.fout, (uchar) c); vm.nchars = (c == '\n' ? 0 : vm.nchars + 1); +#endif // BC_ENABLE_LIBRARY } +#if !BC_ENABLE_LIBRARY static void bc_vm_clean(void) { BcVec *fns = &vm.prog.fns; @@ -491,7 +533,7 @@ static void bc_vm_endif(void) { if (good) { while (BC_PARSE_IF_END(&vm.prs)) bc_vm_process("else {}"); } - else bc_parse_err(&vm.prs, BC_ERROR_PARSE_BLOCK); + else bc_parse_err(&vm.prs, BC_ERR_PARSE_BLOCK); } #endif // BC_ENABLED @@ -604,9 +646,9 @@ restart: if (!BC_STATUS_IS_ERROR(s)) { if (BC_ERR(comment)) - bc_parse_err(&vm.prs, BC_ERROR_PARSE_COMMENT); + bc_parse_err(&vm.prs, BC_ERR_PARSE_COMMENT); else if (BC_ERR(string)) - bc_parse_err(&vm.prs, BC_ERROR_PARSE_STRING); + bc_parse_err(&vm.prs, BC_ERR_PARSE_STRING); #if BC_ENABLED else if (BC_IS_BC) bc_vm_endif(); #endif // BC_ENABLED @@ -652,7 +694,7 @@ static void bc_vm_defaultMsgs(void) { for (i = 0; i < BC_ERR_IDX_NELEMS + BC_ENABLED; ++i) vm.err_ids[i] = bc_errs[i]; - for (i = 0; i < BC_ERROR_NELEMS; ++i) vm.err_msgs[i] = bc_err_msgs[i]; + for (i = 0; i < BC_ERR_NELEMS; ++i) vm.err_msgs[i] = bc_err_msgs[i]; } static void bc_vm_gettext(void) { @@ -683,7 +725,7 @@ static void bc_vm_gettext(void) { i = 0; id = bc_err_ids[i]; - for (set = id + 3, msg = 1; i < BC_ERROR_NELEMS; ++i, ++msg) { + for (set = id + 3, msg = 1; i < BC_ERR_NELEMS; ++i, ++msg) { if (id != bc_err_ids[i]) { msg = 1; @@ -775,8 +817,8 @@ err: #endif // NDEBUG } -void bc_vm_boot(int argc, char *argv[], const char *env_len, - const char* const env_args) +void bc_vm_boot(int argc, char *argv[], const char *env_len, + const char* const env_args) { int ttyin, ttyout, ttyerr; struct sigaction sa; @@ -803,10 +845,7 @@ void bc_vm_boot(int argc, char *argv[], const char *env_len, if (BC_TTY) sigaction(SIGHUP, &sa, NULL); #endif // BC_ENABLE_HISTORY - memcpy(vm.max_num, bc_num_bigdigMax, - bc_num_bigdigMax_size * sizeof(BcDig)); - bc_num_setup(&vm.max, vm.max_num, BC_NUM_BIGDIG_LOG10); - vm.max.len = bc_num_bigdigMax_size; + bc_vm_init(); vm.file = NULL; @@ -822,8 +861,6 @@ void bc_vm_boot(int argc, char *argv[], const char *env_len, bc_vec_clear(&vm.files); bc_vec_clear(&vm.exprs); - bc_vec_init(&vm.temps, sizeof(BcNum), NULL); - bc_program_init(&vm.prog); bc_parse_init(&vm.prs, &vm.prog, BC_PROG_MAIN); @@ -842,6 +879,27 @@ void bc_vm_boot(int argc, char *argv[], const char *env_len, if (BC_IS_POSIX) vm.flags &= ~(BC_FLAG_G); #endif // BC_ENABLED + BC_SIG_UNLOCK; + + bc_vm_exec(); +} +#endif // !BC_ENABLE_LIBRARY + +void bc_vm_init(void) { + + BC_SIG_ASSERT_LOCKED; + + memcpy(vm.max_num, bc_num_bigdigMax, + bc_num_bigdigMax_size * sizeof(BcDig)); + memcpy(vm.max2_num, bc_num_bigdigMax2, + bc_num_bigdigMax2_size * sizeof(BcDig)); + bc_num_setup(&vm.max, vm.max_num, BC_NUM_BIGDIG_LOG10); + bc_num_setup(&vm.max2, vm.max2_num, BC_NUM_BIGDIG_LOG10); + vm.max.len = bc_num_bigdigMax_size; + vm.max2.len = bc_num_bigdigMax2_size; + + bc_vec_init(&vm.temps, sizeof(BcNum), NULL); + vm.maxes[BC_PROG_GLOBALS_IBASE] = BC_NUM_MAX_POSIX_IBASE; vm.maxes[BC_PROG_GLOBALS_OBASE] = BC_MAX_OBASE; vm.maxes[BC_PROG_GLOBALS_SCALE] = BC_MAX_SCALE; @@ -851,11 +909,11 @@ void bc_vm_boot(int argc, char *argv[], const char *env_len, #endif // BC_ENABLE_EXTRA_MATH && BC_ENABLE_RAND #if BC_ENABLED +#if !BC_ENABLE_LIBRARY if (BC_IS_BC && !BC_IS_POSIX) +#endif // !BC_ENABLE_LIBRARY + { vm.maxes[BC_PROG_GLOBALS_IBASE] = BC_NUM_MAX_IBASE; + } #endif // BC_ENABLED - - BC_SIG_UNLOCK; - - bc_vm_exec(); } diff --git a/contrib/bc/tests/bcl.c b/contrib/bc/tests/bcl.c new file mode 100644 index 000000000000..aab2c5d35e9b --- /dev/null +++ b/contrib/bc/tests/bcl.c @@ -0,0 +1,228 @@ +/* + * ***************************************************************************** + * + * SPDX-License-Identifier: BSD-2-Clause + * + * Copyright (c) 2018-2020 Gavin D. Howard and contributors. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * * Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE + * POSSIBILITY OF SUCH DAMAGE. + * + * ***************************************************************************** + * + * Tests for bcl(3). + * + */ + +#include <stdlib.h> +#include <stdbool.h> +#include <string.h> + +#include <bcl.h> + +static void err(BclError e) { + if (e != BCL_ERROR_NONE) abort(); +} + +int main(void) { + + BclError e; + BclContext ctxt; + size_t scale; + BclNumber n, n2, n3, n4, n5, n6; + char* res; + BclBigDig b = 0; + + e = bcl_init(); + err(e); + + e = bcl_init(); + err(e); + + if (bcl_abortOnFatalError()) err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + bcl_setAbortOnFatalError(true); + + if (!bcl_abortOnFatalError()) err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + ctxt = bcl_ctxt_create(); + + bcl_pushContext(ctxt); + + ctxt = bcl_ctxt_create(); + + bcl_pushContext(ctxt); + + scale = 10; + + bcl_ctxt_setScale(ctxt, scale); + + scale = bcl_ctxt_scale(ctxt); + if (scale != 10) err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + scale = 16; + + bcl_ctxt_setIbase(ctxt, scale); + + scale = bcl_ctxt_ibase(ctxt); + if (scale != 16) err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + bcl_ctxt_setObase(ctxt, scale); + + scale = bcl_ctxt_obase(ctxt); + if (scale != 16) err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + bcl_ctxt_setIbase(ctxt, 10); + bcl_ctxt_setObase(ctxt, 10); + + n = bcl_num_create(); + + n2 = bcl_dup(n); + bcl_copy(n, n2); + + n3 = bcl_parse("2938"); + err(bcl_err(n3)); + + n4 = bcl_parse("-28390.9108273"); + err(bcl_err(n4)); + + if (!bcl_num_neg(n4)) err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + n3 = bcl_add(n3, n4); + err(bcl_err(n3)); + + res = bcl_string(bcl_dup(n3)); + if (strcmp(res, "-25452.9108273")) err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + free(res); + + n4 = bcl_parse("8937458902.2890347"); + err(bcl_err(n4)); + + e = bcl_divmod(bcl_dup(n4), n3, &n5, &n6); + err(e); + + res = bcl_string(n5); + + if (strcmp(res, "-351137.0060159482")) + err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + free(res); + + res = bcl_string(n6); + + if (strcmp(res, ".00000152374405414")) + err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + free(res); + + n4 = bcl_sqrt(n4); + err(bcl_err(n4)); + + res = bcl_string(bcl_dup(n4)); + + if (strcmp(res, "94538.1346457028")) + err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + free(res); + + e = bcl_num_setScale(n4, 20); + err(e); + + res = bcl_string(bcl_dup(n4)); + + if (strcmp(res, "94538.13464570280000000000")) + err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + free(res); + + e = bcl_num_setScale(n4, 0); + err(e); + + res = bcl_string(bcl_dup(n4)); + + if (strcmp(res, "94538")) + err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + free(res); + + e = bcl_bigdig(n4, &b); + err(e); + + if (b != 94538) err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + n4 = bcl_bigdig2num(b); + err(bcl_err(n4)); + + res = bcl_string(bcl_dup(n4)); + + if (strcmp(res, "94538")) + err(BCL_ERROR_FATAL_UNKNOWN_ERR); + + free(res); + + n4 = bcl_frand(10); + err(bcl_err(n4)); + + n4 = bcl_lshift(n4, bcl_bigdig2num(10)); + err(bcl_err(n4)); + + n3 = bcl_irand(n4); + err(bcl_err(n3)); + + n2 = bcl_ifrand(bcl_dup(n3), 10); + err(bcl_err(n2)); + + e = bcl_rand_seedWithNum(n3); + err(e); + + n4 = bcl_rand_seed2num(); + err(bcl_err(n4)); + + n5 = bcl_parse("10"); + err(bcl_err(n5)); + + n6 = bcl_modexp(bcl_dup(n5), bcl_dup(n5), bcl_dup(n5)); + err(bcl_err(n6)); + + bcl_num_free(n); + + bcl_ctxt_freeNums(ctxt); + + bcl_gc(); + + bcl_popContext(); + + bcl_ctxt_free(ctxt); + + ctxt = bcl_context(); + + bcl_popContext(); + + bcl_ctxt_free(ctxt); + + bcl_free(); + + bcl_free(); + + return 0; +} |