Fixed conf bug
[geohash-tool.git] / Geo::Hashing.3pm
1 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 . if \nF \{
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
75 .if n \{\
76 . ds #H 0
77 . ds #V .8m
78 . ds #F .3m
79 . ds #[ \f1
80 . ds #] \fP
81 .\}
82 .if t \{\
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 . ds #V .6m
85 . ds #F 0
86 . ds #[ \&
87 . ds #] \&
88 .\}
89 . \" simple accents for nroff and troff
90 .if n \{\
91 . ds ' \&
92 . ds ` \&
93 . ds ^ \&
94 . ds , \&
95 . ds ~ ~
96 . ds /
97 .\}
98 .if t \{\
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 . ds : e
123 . ds 8 ss
124 . ds o a
125 . ds d- d\h'-1'\(ga
126 . ds D- D\h'-1'\(hy
127 . ds th \o'bp'
128 . ds Th \o'LP'
129 . ds ae ae
130 . ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "Hashing 3"
136 .TH Hashing 3 "2015-10-18" "perl v5.20.2" "User Contributed Perl Documentation"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 Geo::Hashing \- Perl library to calculate Geohashing points
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 3
146 \& use Geo::Hashing;
147 \& my $g = new Geo::Hashing(lat => 37, lon => \-122, date => "2008\-05\-24");
148 \& printf "Today\*(Aqs location is at %.6f, %.6f.\en", $g\->lat, $g\->lon;
149 .Ve
150 .SH "DESCRIPTION"
151 .IX Header "DESCRIPTION"
152 This module allows calculating the locaiton of Geohashes as described
153 in http://wiki.xkcd.com/geohashing/Main_Page.
154 .SH "METHODS"
155 .IX Header "METHODS"
156 .SS "new"
157 .IX Subsection "new"
158 Create a new Geo::Hashing object.
159 .SS "lat"
160 .IX Subsection "lat"
161 Set or get the points latitude. When settings, only the integer portion is
162 considered. Set to undef to just get the offset.
163 .SS "lon"
164 .IX Subsection "lon"
165 Set or get the points longitude. When settings, only the integer portion is
166 considered. Set to undef to just get the offset.
167 .SS "date"
168 .IX Subsection "date"
169 Set or get the date used for the calculation. Note that this is the actual
170 date of the meetup in question, even when the 30w rule is in effect.
171 .SS "djia"
172 .IX Subsection "djia"
173 Set or get the Dow Jones Industrial Average used for the calculation. If not
174 set, it will be automatically retrieved depending on the value of
175 \&\f(CW$self\fR\->source. If the data cannot be retrieved, undef will be returned.
176 .SS "source"
177 .IX Subsection "source"
178 Set the source of the \s-1DJIA\s0 opening data. Will load Geo::Hashing::Source::Name
179 and call get_djia($date). See Geo::Hashing::Source::Random for a sample.
180 .SS "use_30w_rule"
181 .IX Subsection "use_30w_rule"
182 Set or get the 30w flag. Will be set automatically if lon is set and is
183 greater than \-30.
184 .SS "debug"
185 .IX Subsection "debug"
186 Enable or disable diagnostic logging
187 .SH "SEE ALSO"
188 .IX Header "SEE ALSO"
189 Original comic: http://www.xkcd.com/426/
190 .PP
191 Wiki: http://wiki.xkcd.com/geohashing/Main_Page
192 .PP
193 \&\s-1IRC:\s0 irc://irc.xkcd.com/geohashing
194 .SH "AUTHOR"
195 .IX Header "AUTHOR"
196 Dan Boger, <zigdon@gmail.com>
197 .SH "COPYRIGHT AND LICENSE"
198 .IX Header "COPYRIGHT AND LICENSE"
199 Copyright (C) 2008 by Dan Boger
200 .PP
201 This library is free software; you can redistribute it and/or modify
202 it under the same terms as Perl itself, either Perl version 5.10.0 or,
203 at your option, any later version of Perl 5 you may have available.