8354 sync regcomp(3C) with upstream (fix make catalog)
[unleashed/tickless.git] / usr / src / lib / libast / common / man / strton.3
blobbfcf8918a0a28e62142342f8c902628be50b0ffe
1 .fp 5 CW
2 .de Af
3 .ds ;G \\*(;G\\f\\$1\\$3\\f\\$2
4 .if !\a\\$4\a\a .Af \\$2 \\$1 "\\$4" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9"
5 ..
6 .de aF
7 .ie \a\\$3\a\a .ft \\$1
8 .el \{\
9 .ds ;G \&
10 .nr ;G \\n(.f
11 .Af "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7" "\\$8" "\\$9"
12 \\*(;G
13 .ft \\n(;G \}
15 .de L
16 .aF 5 \\n(.f "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
18 .de LR
19 .aF 5 1 "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
21 .de RL
22 .aF 1 5 "\\$1" "\\$2" "\\$3" "\\$4" "\\$5" "\\$6" "\\$7"
24 .de EX          \" start example
25 .ta 1i 2i 3i 4i 5i 6i
26 .PP
27 .RS 
28 .PD 0
29 .ft 5
30 .nf
32 .de EE          \" end example
33 .fi
34 .ft
35 .PD
36 .RE
37 .PP
39 .TH STRTON 3
40 .SH NAME
41 strton \- convert string to long integer
42 .SH SYNOPSIS
43 .L "long strton(char* s, char** e)"
44 .SH DESCRIPTION
45 .I strton
46 converts the nul-terminated string
47 .I s
48 to a long integer.
49 If 
50 .I e
51 not 0 then
52 .I *e
53 is set to point to the first unrecognized character in
54 .IR s .
55 Leading spaces in
56 .I s
57 are ignored.
58 .PP
59 A number is composed of
60 .IR sign-base-number-suffix .
61 All but
62 .I number
63 are optional.
64 .I sign
65 may be \+ or \-.
66 .I base 
67 may be:
68 .TP
69 .B 0x
70 for hexadecimal;
71 .TP
72 .B 0
73 for octal, or
74 .TP
75 .IR nn #
76 for base
77 2 \(le
78 .I nn
79 \(le 36.
80 .PP
81 For bases greater than 10 the additional digits are take from the set
82 .BR [a-zA-Z] .
83 The suffix multiplies the converted number and may be:
84 .TP
85 .B b
86 block (512)
87 .TP
88 .B g
89 giga (1024 * 1024 * 1024)
90 .TP
91 .B k
92 kilo (1024)
93 .TP
94 .B m
95 mega (1024 * 1024)
96 .SH "SEE ALSO"
97 atoi(3), scanf(3), strtod(3)