share/man/man1/dc.1

   1 '\" te
   2 .\"  Copyright 1989 AT&T  Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH DC 1 "Oct 25, 2017"
   7 .SH NAME
   8 dc \- desk calculator
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/bin/dc\fR [\fIfilename\fR]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 \fBdc\fR is an arbitrary precision arithmetic package. Ordinarily it operates
  19 on decimal integers, but one may specify an input base, output base, and a
  20 number of fractional digits to be maintained. The overall structure of \fBdc\fR
  21 is a stacking (reverse Polish) calculator. If an argument is given, input is
  22 taken from that file until its end, then from the standard input.
  23 .sp
  24 .LP
  25 \fBbc\fR is a preprocessor for \fBdc\fR that provides infix notation and a
  26 C-like syntax that implements functions. \fBbc\fR also provides reasonable
  27 control structures for programs. See \fBbc\fR(1).
  28 .SH USAGE
  29 .sp
  30 .LP
  31 The following constructions are recognized:
  32 .sp
  33 .ne 2
  34 .na
  35 \fB\fInumber\fR\fR
  36 .ad
  37 .RS 15n
  38 The value of the number is pushed on the stack. A number is an  unbroken string
  39 of the digits 0\(mi9. It may be preceded by an underscore (\fB_\fR) to input a
  40 negative number. Numbers may  contain decimal points.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBs\fR\fIx\fR\fR
  47 .ad
  48 .RS 15n
  49 The top of the stack is popped and stored into a register named \fIx\fR, where
  50 \fIx\fR may be any character.  If the \fBs\fR is capitalized, \fIx\fR is
  51 treated as a stack and the value is pushed on it.
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBl\fR\fIx\fR\fR
  58 .ad
  59 .RS 15n
  60 The value in register \fIx\fR is pushed on the stack. The register \fIx\fR is
  61 not altered. All registers start with zero value.  If the \fBl\fR is
  62 capitalized, register \fIx\fR is treated as a stack and its top value is popped
  63 onto the main stack.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBd\fR\fR
  70 .ad
  71 .RS 15n
  72 The top value on the stack is duplicated.
  73 .RE
  74
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBp\fR\fR
  79 .ad
  80 .RS 15n
  81 The top value on the stack is printed. The top value remains  unchanged.
  82 .RE
  83
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBP\fR\fR
  88 .ad
  89 .RS 15n
  90 Interprets the top of the stack as an ASCII string, removes it,  and prints it.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBf\fR\fR
  97 .ad
  98 .RS 15n
  99 All values on the stack are printed.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBq\fR\fR
 106 .ad
 107 .RS 15n
 108 Exits the program. If executing a string, the recursion level is popped by two.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBQ\fR\fR
 115 .ad
 116 .RS 15n
 117 Exits the program.  The top value on the stack is popped and the string
 118 execution level is popped by that value.
 119 .RE
 120
 121 .sp
 122 .ne 2
 123 .na
 124 \fB\fBx\fR\fR
 125 .ad
 126 .RS 15n
 127 Treats the top element of the stack as a character string and executes it as a
 128 string of \fBdc\fR commands.
 129 .RE
 130
 131 .sp
 132 .ne 2
 133 .na
 134 \fB\fBX\fR\fR
 135 .ad
 136 .RS 15n
 137 Replaces the number on the top of the stack with its scale factor.
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fB[ ... ]\fR\fR
 144 .ad
 145 .RS 15n
 146 Puts the bracketed ASCII string onto the top of the stack.
 147 .RE
 148
 149 .sp
 150 .ne 2
 151 .na
 152 \fB\fB<\fR\fIx \fR \fB>\fR\fIx \fR \fB=\fR\fIx \fR\fR
 153 .ad
 154 .RS 15n
 155 The top two elements of the stack are popped and compared. Register \fIx\fR is
 156 evaluated if they obey the stated relation.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBv\fR\fR
 163 .ad
 164 .RS 15n
 165 Replaces the top element on the stack by its square root.  Any  existing
 166 fractional part of the argument is taken into account, but  otherwise the scale
 167 factor is ignored.
 168 .RE
 169
 170 .sp
 171 .ne 2
 172 .na
 173 \fB\fB!\fR\fR
 174 .ad
 175 .RS 15n
 176 Interprets the rest of the line as a shell command.
 177 .RE
 178
 179 .sp
 180 .ne 2
 181 .na
 182 \fB\fBc\fR\fR
 183 .ad
 184 .RS 15n
 185 All values on the stack are popped.
 186 .RE
 187
 188 .sp
 189 .ne 2
 190 .na
 191 \fB\fBi\fR\fR
 192 .ad
 193 .RS 15n
 194 The top value on the stack is popped and used as the number radix  for further
 195 input.
 196 .RE
 197
 198 .sp
 199 .ne 2
 200 .na
 201 \fB\fBI\fR\fR
 202 .ad
 203 .RS 15n
 204 Pushes the input base on the top of the stack.
 205 .RE
 206
 207 .sp
 208 .ne 2
 209 .na
 210 \fB\fBo\fR\fR
 211 .ad
 212 .RS 15n
 213 The top value on the stack is popped and used as the number radix for  further
 214 output.
 215 .RE
 216
 217 .sp
 218 .ne 2
 219 .na
 220 \fB\fBO\fR\fR
 221 .ad
 222 .RS 15n
 223 Pushes the output base on the top of the stack.
 224 .RE
 225
 226 .sp
 227 .ne 2
 228 .na
 229 \fB\fBk\fR\fR
 230 .ad
 231 .RS 15n
 232 The top of the stack is popped, and that value is used as a  non-negative scale
 233 factor: the appropriate number of places are  printed on output, and maintained
 234 during multiplication, division,  and exponentiation.  The interaction of scale
 235 factor, input base, and  output base will be reasonable if all are changed
 236 together.
 237 .RE
 238
 239 .sp
 240 .ne 2
 241 .na
 242 \fB\fBK\fR\fR
 243 .ad
 244 .RS 15n
 245 Pushes the current scale factor on the top of the stack.
 246 .RE
 247
 248 .sp
 249 .ne 2
 250 .na
 251 \fB\fBz\fR\fR
 252 .ad
 253 .RS 15n
 254 The stack level is pushed onto the stack.
 255 .RE
 256
 257 .sp
 258 .ne 2
 259 .na
 260 \fB\fBZ\fR\fR
 261 .ad
 262 .RS 15n
 263 Replaces the number on the top of the stack with its length.
 264 .RE
 265
 266 .sp
 267 .ne 2
 268 .na
 269 \fB\fB?\fR\fR
 270 .ad
 271 .RS 15n
 272 A line of input is taken from the input source (usually the terminal) and
 273 executed.
 274 .RE
 275
 276 .sp
 277 .ne 2
 278 .na
 279 \fB\fBY\fR\fR
 280 .ad
 281 .RS 15n
 282 Displays \fBdc\fR debugging information.
 283 .RE
 284
 285 .sp
 286 .ne 2
 287 .na
 288 \fB\fB; :\fR\fR
 289 .ad
 290 .RS 15n
 291 Used by  \fBbc\fR(1) for array operations.
 292 .RE
 293
 294 .sp
 295 .LP
 296 The results of division are forced to be a scale of 20.
 297 .sp
 298 .ne 2
 299 .na
 300 \fB\fB+ \(mi / * % ^\fR\fR
 301 .ad
 302 .RS 18n
 303 The top two values on the stack are added (\fB+\fR), subtracted (\fB\(mi\fR),
 304 multiplied (\fB*\fR), divided (\fB/\fR), remaindered (\fB%\fR), or
 305 exponentiated (\fB^\fR). The two entries are popped off the stack. The result
 306 is pushed on the stack in their place. Any fractional part of an exponent is
 307 ignored.
 308 .sp
 309 Ensures that the scale set prior to division is the scale of the result.
 310 .RE
 311
 312 .SH EXAMPLES
 313 .LP
 314 \fBExample 1 \fRPrinting the first ten values of n!
 315 .sp
 316 .LP
 317 This example prints the first ten values of n!:
 318
 319 .sp
 320 .in +2
 321 .nf
 322 [la1+dsa*pla10>y]sy
 323 0sa1
 324 lyx
 325 .fi
 326 .in -2
 327 .sp
 328
 329 .SH SEE ALSO
 330 .sp
 331 .LP
 332 \fBbc\fR(1), \fBattributes\fR(5)
 333 .SH DIAGNOSTICS
 334 .sp
 335 .ne 2
 336 .na
 337 \fB\fIx\fR \fBis unimplemented\fR\fR
 338 .ad
 339 .RS 29n
 340 \fIx\fR is an octal number.
 341 .RE
 342
 343 .sp
 344 .ne 2
 345 .na
 346 \fB\fBout of space\fR\fR
 347 .ad
 348 .RS 29n
 349 The free list is exhausted (too many digits).
 350 .RE
 351
 352 .sp
 353 .ne 2
 354 .na
 355 \fB\fBout of stack space\fR\fR
 356 .ad
 357 .RS 29n
 358 Too many pushes onto the stack (stack overflow).
 359 .RE
 360
 361 .sp
 362 .ne 2
 363 .na
 364 \fB\fBempty stack\fR\fR
 365 .ad
 366 .RS 29n
 367 Too many pops from the stack (stack underflow).
 368 .RE
 369
 370 .sp
 371 .ne 2
 372 .na
 373 \fB\fBnesting depth\fR\fR
 374 .ad
 375 .RS 29n
 376 Too many levels of nested execution.
 377 .RE
 378
 379 .sp
 380 .ne 2
 381 .na
 382 \fB\fBdivide by 0\fR\fR
 383 .ad
 384 .RS 29n
 385 Division by zero.
 386 .RE
 387
 388 .sp
 389 .ne 2
 390 .na
 391 \fB\fBsqrt of neg number\fR\fR
 392 .ad
 393 .RS 29n
 394 Square root of a negative number is not defined (no imaginary numbers).
 395 .RE
 396
 397 .sp
 398 .ne 2
 399 .na
 400 \fB\fBexp not an integer\fR\fR
 401 .ad
 402 .RS 29n
 403 \fBdc\fR only processes integer exponentiation.
 404 .RE
 405
 406 .sp
 407 .ne 2
 408 .na
 409 \fB\fBexp too big\fR\fR
 410 .ad
 411 .RS 29n
 412 The largest exponent allowed is 999.
 413 .RE
 414
 415 .sp
 416 .ne 2
 417 .na
 418 \fB\fBinput base is too large\fR\fR
 419 .ad
 420 .RS 29n
 421 The input base x: 2<= x <= 16.
 422 .RE
 423
 424 .sp
 425 .ne 2
 426 .na
 427 \fB\fBinput base is too small\fR\fR
 428 .ad
 429 .RS 29n
 430 The input base x: 2<= x <= 16.
 431 .RE
 432
 433 .sp
 434 .ne 2
 435 .na
 436 \fB\fBoutput base is too large\fR\fR
 437 .ad
 438 .RS 29n
 439 The output base must be no larger than  \fBBC_BASE_MAX\fR.
 440 .RE
 441
 442 .sp
 443 .ne 2
 444 .na
 445 \fB\fBinvalid scale factor\fR\fR
 446 .ad
 447 .RS 29n
 448 Scale factor cannot be less than 1.
 449 .RE
 450
 451 .sp
 452 .ne 2
 453 .na
 454 \fB\fBscale factor is too large\fR\fR
 455 .ad
 456 .RS 29n
 457 A scale factor cannot be larger than  \fBBC_SCALE_MAX\fR.
 458 .RE
 459
 460 .sp
 461 .ne 2
 462 .na
 463 \fB\fBsymbol table overflow\fR\fR
 464 .ad
 465 .RS 29n
 466 Too many variables have been specified.
 467 .RE
 468
 469 .sp
 470 .ne 2
 471 .na
 472 \fB\fBinvalid index\fR\fR
 473 .ad
 474 .RS 29n
 475 Index cannot be less than 1.
 476 .RE
 477
 478 .sp
 479 .ne 2
 480 .na
 481 \fB\fBindex is too large\fR\fR
 482 .ad
 483 .RS 29n
 484 An index cannot be larger than  \fBBC_DIM_MAX\fR.
 485 .RE
 486