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