]> git.lizzy.rs Git - plan9front.git/blob - sys/man/1/pc
pc(1): manpage formatting
[plan9front.git] / sys / man / 1 / pc
1 .TH PC 1
2 .SH NAME
3 pc \- programmer's calculator
4 .SH SYNOPSIS
5 .B pc
6 [
7 .B -n
8 ]
9 .SH DESCRIPTION
10 .I Pc
11 is an arbitrary precision calculator with a special emphasis on supporting two's complement bit operations and working with different number bases.
12 .PP
13 .I Pc
14 reads input statements which are either expressions or control statements.
15 Multiple statements in one line can be separated by semicolons.
16 .I Pc
17 prints the value of all expressions that are not terminated by a semicolon.
18 .PP
19 .I Pc
20 can be run non-interactively by using the
21 .B -n
22 switch. In this case no input prompt is printed.
23 .PP
24 Expressions can use the C-like operators
25 .TP
26 .B + - * ** \fR(exponentiation\fR)
27 .TP
28 .B / % \fR(Euclidean division, by default\fR)
29 .TP
30 .B "& | ^ ~ ! << >>"
31 .TP
32 .B "&& || \fR(returning the second argument, if appropriate)"
33 .TP
34 .B < >= < <= == !=
35 .PP
36 Variables can be defined using
37 .BR = .
38 The builtin variable
39 .B @
40 always refers to the last printed result.
41 .PP
42 Numbers can use the prefixes
43 .B 0b
44 (binary), 
45 .B 0
46 (octal),
47 .B 0d
48 (decimal) and
49 .B 0x
50 (hexadecimal).
51 .B _
52 in numbers can be added for readability and is ignored.
53 .SS Builtin functions
54 .TF \fIcat(a0,n0,...,aN,nN)
55 .TP
56 .I bin(n)
57 Display \fIn\fR in binary.
58 .TP
59 .I oct(n)
60 Display \fIn\fR in octal.
61 .TP
62 .I dec(n)
63 Display \fIn\fR in decimal.
64 .TP
65 .I hex(n)
66 Display \fIn\fR in hexadecimal.
67 .TP
68 .I abs(n)
69 Absolute value of \fIn\fR.
70 .TP
71 .I round(n,m)
72 \fIn\fR rounded to the nearest multiple of \fIm\fR.
73 Numbers exactly halfway between are rounded to the next even multiple.
74 .TP
75 .I floor(n,m)
76 \fIn\fR rounded down to the next multiple of \fIm\fR.
77 .TP
78 .I ceil(n,m)
79 \fIn\fR rounded up to the next multiple of \fIm\fR.
80 .TP
81 .I trunc(n,m)
82 \fIn\fR truncated to \fIm\fR bits.
83 .TP
84 .I xtend(n,m)
85 \fIn\fR truncated to \fIm\fR bits, with the highest bit interpreted as a sign bit.
86 .TP
87 .I rev(n,m)
88 \fIn\fR truncated to \fIm\fR bits, with the order of bits reversed.
89 .TP
90 .I ubits(n)
91 The minimum number of bits required to represent \fIn\fR as an unsigned number.
92 .TP
93 .I sbits(n)
94 The minimum number of bits required to represent \fIn\fR as an signed number.
95 .TP
96 .I cat(a\d\s70\s10\u,n\d\s70\s10\u,...,a\d\s7N\s10\u,n\d\s7N\s10\u)
97 Truncate each of the \fIa\d\s7i\s10\u\fR arguments to \fIn\d\s7i\s10\u\fR bits and concatenate their binary representation.
98 .TP
99 .I gcd(n,m)
100 The greatest common divisor of \fIn\fR and \fIm\fR.
101 .TP
102 .I minv(n,m)
103 The inverse of \fIn\fR mod \fIm\fR.
104 .TP
105 .I rand(n)
106 A random number satisfying 0 ≤ \fIrand(n)\fR < \fIn\fR.
107 .SS Control statements
108 .PP
109 Control statements are always evaluated with default input base 10.
110 .TP
111 \fL_\fR \fIn\fR
112 If \fIn\fR ≠ 0, insert 
113 .B _
114 in all printed numbers, every
115 .I n
116 digits.
117 .TP
118 \fL<\fR \fIn\fR
119 Set the default input base to \fIn\fR (default 10).
120 The input base can always be overriden by the base prefixes defined above.
121 .TP
122 \fL>\fR \fIn\fR
123 Set the output base to \fIn\fR.
124 If \fIn\fR = 0 (default), print each number in the base it was input in.
125 .TP
126 \fL/\fR 0
127 Use Euclidean division (default).
128 \fIa\fR / \fIb\fR is rounded towards ±∞ (opposite sign as \fIb\fR).
129 \fIa\fR % \fIb\fR is always non-negative.
130 .TP
131 \fL/\fR 1
132 Use truncating division (same as C).
133 \fIa\fR / \fIb\fR is rounded towards zero.
134 \fIa\fR % \fIb\fR can be negative.
135 .SH SOURCE
136 .B /sys/src/cmd/pc.y
137 .SH "SEE ALSO"
138 .IR bc (1),
139 .IR hoc (1)
140 .SH BUGS
141 With the input base set to 16, terms such as
142 .B ABC
143 are ambiguous.
144 They are interpreted as numbers only if there is no function or variable of the same name.
145 To force interpretation as a number, use the \fL0x\fR prefix.
146 .PP
147 Arbitrary bases should be supported, but are not supported by the
148 .IR mp (2)
149 string functions.
150 .SH HISTORY
151 .I Pc
152 first appeared in 9front (August, 2016).