zerodogg-phpdocr 0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. data/COPYING +676 -0
  2. data/NEWS +2 -0
  3. data/README +11 -0
  4. data/phpdocr +528 -0
  5. data/phpdocr.1 +102 -0
  6. metadata +67 -0
data/COPYING ADDED
@@ -0,0 +1,676 @@
1
+
2
+ GNU GENERAL PUBLIC LICENSE
3
+ Version 3, 29 June 2007
4
+
5
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ Preamble
10
+
11
+ The GNU General Public License is a free, copyleft license for
12
+ software and other kinds of works.
13
+
14
+ The licenses for most software and other practical works are designed
15
+ to take away your freedom to share and change the works. By contrast,
16
+ the GNU General Public License is intended to guarantee your freedom to
17
+ share and change all versions of a program--to make sure it remains free
18
+ software for all its users. We, the Free Software Foundation, use the
19
+ GNU General Public License for most of our software; it applies also to
20
+ any other work released this way by its authors. You can apply it to
21
+ your programs, too.
22
+
23
+ When we speak of free software, we are referring to freedom, not
24
+ price. Our General Public Licenses are designed to make sure that you
25
+ have the freedom to distribute copies of free software (and charge for
26
+ them if you wish), that you receive source code or can get it if you
27
+ want it, that you can change the software or use pieces of it in new
28
+ free programs, and that you know you can do these things.
29
+
30
+ To protect your rights, we need to prevent others from denying you
31
+ these rights or asking you to surrender the rights. Therefore, you have
32
+ certain responsibilities if you distribute copies of the software, or if
33
+ you modify it: responsibilities to respect the freedom of others.
34
+
35
+ For example, if you distribute copies of such a program, whether
36
+ gratis or for a fee, you must pass on to the recipients the same
37
+ freedoms that you received. You must make sure that they, too, receive
38
+ or can get the source code. And you must show them these terms so they
39
+ know their rights.
40
+
41
+ Developers that use the GNU GPL protect your rights with two steps:
42
+ (1) assert copyright on the software, and (2) offer you this License
43
+ giving you legal permission to copy, distribute and/or modify it.
44
+
45
+ For the developers' and authors' protection, the GPL clearly explains
46
+ that there is no warranty for this free software. For both users' and
47
+ authors' sake, the GPL requires that modified versions be marked as
48
+ changed, so that their problems will not be attributed erroneously to
49
+ authors of previous versions.
50
+
51
+ Some devices are designed to deny users access to install or run
52
+ modified versions of the software inside them, although the manufacturer
53
+ can do so. This is fundamentally incompatible with the aim of
54
+ protecting users' freedom to change the software. The systematic
55
+ pattern of such abuse occurs in the area of products for individuals to
56
+ use, which is precisely where it is most unacceptable. Therefore, we
57
+ have designed this version of the GPL to prohibit the practice for those
58
+ products. If such problems arise substantially in other domains, we
59
+ stand ready to extend this provision to those domains in future versions
60
+ of the GPL, as needed to protect the freedom of users.
61
+
62
+ Finally, every program is threatened constantly by software patents.
63
+ States should not allow patents to restrict development and use of
64
+ software on general-purpose computers, but in those that do, we wish to
65
+ avoid the special danger that patents applied to a free program could
66
+ make it effectively proprietary. To prevent this, the GPL assures that
67
+ patents cannot be used to render the program non-free.
68
+
69
+ The precise terms and conditions for copying, distribution and
70
+ modification follow.
71
+
72
+ TERMS AND CONDITIONS
73
+
74
+ 0. Definitions.
75
+
76
+ "This License" refers to version 3 of the GNU General Public License.
77
+
78
+ "Copyright" also means copyright-like laws that apply to other kinds of
79
+ works, such as semiconductor masks.
80
+
81
+ "The Program" refers to any copyrightable work licensed under this
82
+ License. Each licensee is addressed as "you". "Licensees" and
83
+ "recipients" may be individuals or organizations.
84
+
85
+ To "modify" a work means to copy from or adapt all or part of the work
86
+ in a fashion requiring copyright permission, other than the making of an
87
+ exact copy. The resulting work is called a "modified version" of the
88
+ earlier work or a work "based on" the earlier work.
89
+
90
+ A "covered work" means either the unmodified Program or a work based
91
+ on the Program.
92
+
93
+ To "propagate" a work means to do anything with it that, without
94
+ permission, would make you directly or secondarily liable for
95
+ infringement under applicable copyright law, except executing it on a
96
+ computer or modifying a private copy. Propagation includes copying,
97
+ distribution (with or without modification), making available to the
98
+ public, and in some countries other activities as well.
99
+
100
+ To "convey" a work means any kind of propagation that enables other
101
+ parties to make or receive copies. Mere interaction with a user through
102
+ a computer network, with no transfer of a copy, is not conveying.
103
+
104
+ An interactive user interface displays "Appropriate Legal Notices"
105
+ to the extent that it includes a convenient and prominently visible
106
+ feature that (1) displays an appropriate copyright notice, and (2)
107
+ tells the user that there is no warranty for the work (except to the
108
+ extent that warranties are provided), that licensees may convey the
109
+ work under this License, and how to view a copy of this License. If
110
+ the interface presents a list of user commands or options, such as a
111
+ menu, a prominent item in the list meets this criterion.
112
+
113
+ 1. Source Code.
114
+
115
+ The "source code" for a work means the preferred form of the work
116
+ for making modifications to it. "Object code" means any non-source
117
+ form of a work.
118
+
119
+ A "Standard Interface" means an interface that either is an official
120
+ standard defined by a recognized standards body, or, in the case of
121
+ interfaces specified for a particular programming language, one that
122
+ is widely used among developers working in that language.
123
+
124
+ The "System Libraries" of an executable work include anything, other
125
+ than the work as a whole, that (a) is included in the normal form of
126
+ packaging a Major Component, but which is not part of that Major
127
+ Component, and (b) serves only to enable use of the work with that
128
+ Major Component, or to implement a Standard Interface for which an
129
+ implementation is available to the public in source code form. A
130
+ "Major Component", in this context, means a major essential component
131
+ (kernel, window system, and so on) of the specific operating system
132
+ (if any) on which the executable work runs, or a compiler used to
133
+ produce the work, or an object code interpreter used to run it.
134
+
135
+ The "Corresponding Source" for a work in object code form means all
136
+ the source code needed to generate, install, and (for an executable
137
+ work) run the object code and to modify the work, including scripts to
138
+ control those activities. However, it does not include the work's
139
+ System Libraries, or general-purpose tools or generally available free
140
+ programs which are used unmodified in performing those activities but
141
+ which are not part of the work. For example, Corresponding Source
142
+ includes interface definition files associated with source files for
143
+ the work, and the source code for shared libraries and dynamically
144
+ linked subprograms that the work is specifically designed to require,
145
+ such as by intimate data communication or control flow between those
146
+ subprograms and other parts of the work.
147
+
148
+ The Corresponding Source need not include anything that users
149
+ can regenerate automatically from other parts of the Corresponding
150
+ Source.
151
+
152
+ The Corresponding Source for a work in source code form is that
153
+ same work.
154
+
155
+ 2. Basic Permissions.
156
+
157
+ All rights granted under this License are granted for the term of
158
+ copyright on the Program, and are irrevocable provided the stated
159
+ conditions are met. This License explicitly affirms your unlimited
160
+ permission to run the unmodified Program. The output from running a
161
+ covered work is covered by this License only if the output, given its
162
+ content, constitutes a covered work. This License acknowledges your
163
+ rights of fair use or other equivalent, as provided by copyright law.
164
+
165
+ You may make, run and propagate covered works that you do not
166
+ convey, without conditions so long as your license otherwise remains
167
+ in force. You may convey covered works to others for the sole purpose
168
+ of having them make modifications exclusively for you, or provide you
169
+ with facilities for running those works, provided that you comply with
170
+ the terms of this License in conveying all material for which you do
171
+ not control copyright. Those thus making or running the covered works
172
+ for you must do so exclusively on your behalf, under your direction
173
+ and control, on terms that prohibit them from making any copies of
174
+ your copyrighted material outside their relationship with you.
175
+
176
+ Conveying under any other circumstances is permitted solely under
177
+ the conditions stated below. Sublicensing is not allowed; section 10
178
+ makes it unnecessary.
179
+
180
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
181
+
182
+ No covered work shall be deemed part of an effective technological
183
+ measure under any applicable law fulfilling obligations under article
184
+ 11 of the WIPO copyright treaty adopted on 20 December 1996, or
185
+ similar laws prohibiting or restricting circumvention of such
186
+ measures.
187
+
188
+ When you convey a covered work, you waive any legal power to forbid
189
+ circumvention of technological measures to the extent such circumvention
190
+ is effected by exercising rights under this License with respect to
191
+ the covered work, and you disclaim any intention to limit operation or
192
+ modification of the work as a means of enforcing, against the work's
193
+ users, your or third parties' legal rights to forbid circumvention of
194
+ technological measures.
195
+
196
+ 4. Conveying Verbatim Copies.
197
+
198
+ You may convey verbatim copies of the Program's source code as you
199
+ receive it, in any medium, provided that you conspicuously and
200
+ appropriately publish on each copy an appropriate copyright notice;
201
+ keep intact all notices stating that this License and any
202
+ non-permissive terms added in accord with section 7 apply to the code;
203
+ keep intact all notices of the absence of any warranty; and give all
204
+ recipients a copy of this License along with the Program.
205
+
206
+ You may charge any price or no price for each copy that you convey,
207
+ and you may offer support or warranty protection for a fee.
208
+
209
+ 5. Conveying Modified Source Versions.
210
+
211
+ You may convey a work based on the Program, or the modifications to
212
+ produce it from the Program, in the form of source code under the
213
+ terms of section 4, provided that you also meet all of these conditions:
214
+
215
+ a) The work must carry prominent notices stating that you modified
216
+ it, and giving a relevant date.
217
+
218
+ b) The work must carry prominent notices stating that it is
219
+ released under this License and any conditions added under section
220
+ 7. This requirement modifies the requirement in section 4 to
221
+ "keep intact all notices".
222
+
223
+ c) You must license the entire work, as a whole, under this
224
+ License to anyone who comes into possession of a copy. This
225
+ License will therefore apply, along with any applicable section 7
226
+ additional terms, to the whole of the work, and all its parts,
227
+ regardless of how they are packaged. This License gives no
228
+ permission to license the work in any other way, but it does not
229
+ invalidate such permission if you have separately received it.
230
+
231
+ d) If the work has interactive user interfaces, each must display
232
+ Appropriate Legal Notices; however, if the Program has interactive
233
+ interfaces that do not display Appropriate Legal Notices, your
234
+ work need not make them do so.
235
+
236
+ A compilation of a covered work with other separate and independent
237
+ works, which are not by their nature extensions of the covered work,
238
+ and which are not combined with it such as to form a larger program,
239
+ in or on a volume of a storage or distribution medium, is called an
240
+ "aggregate" if the compilation and its resulting copyright are not
241
+ used to limit the access or legal rights of the compilation's users
242
+ beyond what the individual works permit. Inclusion of a covered work
243
+ in an aggregate does not cause this License to apply to the other
244
+ parts of the aggregate.
245
+
246
+ 6. Conveying Non-Source Forms.
247
+
248
+ You may convey a covered work in object code form under the terms
249
+ of sections 4 and 5, provided that you also convey the
250
+ machine-readable Corresponding Source under the terms of this License,
251
+ in one of these ways:
252
+
253
+ a) Convey the object code in, or embodied in, a physical product
254
+ (including a physical distribution medium), accompanied by the
255
+ Corresponding Source fixed on a durable physical medium
256
+ customarily used for software interchange.
257
+
258
+ b) Convey the object code in, or embodied in, a physical product
259
+ (including a physical distribution medium), accompanied by a
260
+ written offer, valid for at least three years and valid for as
261
+ long as you offer spare parts or customer support for that product
262
+ model, to give anyone who possesses the object code either (1) a
263
+ copy of the Corresponding Source for all the software in the
264
+ product that is covered by this License, on a durable physical
265
+ medium customarily used for software interchange, for a price no
266
+ more than your reasonable cost of physically performing this
267
+ conveying of source, or (2) access to copy the
268
+ Corresponding Source from a network server at no charge.
269
+
270
+ c) Convey individual copies of the object code with a copy of the
271
+ written offer to provide the Corresponding Source. This
272
+ alternative is allowed only occasionally and noncommercially, and
273
+ only if you received the object code with such an offer, in accord
274
+ with subsection 6b.
275
+
276
+ d) Convey the object code by offering access from a designated
277
+ place (gratis or for a charge), and offer equivalent access to the
278
+ Corresponding Source in the same way through the same place at no
279
+ further charge. You need not require recipients to copy the
280
+ Corresponding Source along with the object code. If the place to
281
+ copy the object code is a network server, the Corresponding Source
282
+ may be on a different server (operated by you or a third party)
283
+ that supports equivalent copying facilities, provided you maintain
284
+ clear directions next to the object code saying where to find the
285
+ Corresponding Source. Regardless of what server hosts the
286
+ Corresponding Source, you remain obligated to ensure that it is
287
+ available for as long as needed to satisfy these requirements.
288
+
289
+ e) Convey the object code using peer-to-peer transmission, provided
290
+ you inform other peers where the object code and Corresponding
291
+ Source of the work are being offered to the general public at no
292
+ charge under subsection 6d.
293
+
294
+ A separable portion of the object code, whose source code is excluded
295
+ from the Corresponding Source as a System Library, need not be
296
+ included in conveying the object code work.
297
+
298
+ A "User Product" is either (1) a "consumer product", which means any
299
+ tangible personal property which is normally used for personal, family,
300
+ or household purposes, or (2) anything designed or sold for incorporation
301
+ into a dwelling. In determining whether a product is a consumer product,
302
+ doubtful cases shall be resolved in favor of coverage. For a particular
303
+ product received by a particular user, "normally used" refers to a
304
+ typical or common use of that class of product, regardless of the status
305
+ of the particular user or of the way in which the particular user
306
+ actually uses, or expects or is expected to use, the product. A product
307
+ is a consumer product regardless of whether the product has substantial
308
+ commercial, industrial or non-consumer uses, unless such uses represent
309
+ the only significant mode of use of the product.
310
+
311
+ "Installation Information" for a User Product means any methods,
312
+ procedures, authorization keys, or other information required to install
313
+ and execute modified versions of a covered work in that User Product from
314
+ a modified version of its Corresponding Source. The information must
315
+ suffice to ensure that the continued functioning of the modified object
316
+ code is in no case prevented or interfered with solely because
317
+ modification has been made.
318
+
319
+ If you convey an object code work under this section in, or with, or
320
+ specifically for use in, a User Product, and the conveying occurs as
321
+ part of a transaction in which the right of possession and use of the
322
+ User Product is transferred to the recipient in perpetuity or for a
323
+ fixed term (regardless of how the transaction is characterized), the
324
+ Corresponding Source conveyed under this section must be accompanied
325
+ by the Installation Information. But this requirement does not apply
326
+ if neither you nor any third party retains the ability to install
327
+ modified object code on the User Product (for example, the work has
328
+ been installed in ROM).
329
+
330
+ The requirement to provide Installation Information does not include a
331
+ requirement to continue to provide support service, warranty, or updates
332
+ for a work that has been modified or installed by the recipient, or for
333
+ the User Product in which it has been modified or installed. Access to a
334
+ network may be denied when the modification itself materially and
335
+ adversely affects the operation of the network or violates the rules and
336
+ protocols for communication across the network.
337
+
338
+ Corresponding Source conveyed, and Installation Information provided,
339
+ in accord with this section must be in a format that is publicly
340
+ documented (and with an implementation available to the public in
341
+ source code form), and must require no special password or key for
342
+ unpacking, reading or copying.
343
+
344
+ 7. Additional Terms.
345
+
346
+ "Additional permissions" are terms that supplement the terms of this
347
+ License by making exceptions from one or more of its conditions.
348
+ Additional permissions that are applicable to the entire Program shall
349
+ be treated as though they were included in this License, to the extent
350
+ that they are valid under applicable law. If additional permissions
351
+ apply only to part of the Program, that part may be used separately
352
+ under those permissions, but the entire Program remains governed by
353
+ this License without regard to the additional permissions.
354
+
355
+ When you convey a copy of a covered work, you may at your option
356
+ remove any additional permissions from that copy, or from any part of
357
+ it. (Additional permissions may be written to require their own
358
+ removal in certain cases when you modify the work.) You may place
359
+ additional permissions on material, added by you to a covered work,
360
+ for which you have or can give appropriate copyright permission.
361
+
362
+ Notwithstanding any other provision of this License, for material you
363
+ add to a covered work, you may (if authorized by the copyright holders of
364
+ that material) supplement the terms of this License with terms:
365
+
366
+ a) Disclaiming warranty or limiting liability differently from the
367
+ terms of sections 15 and 16 of this License; or
368
+
369
+ b) Requiring preservation of specified reasonable legal notices or
370
+ author attributions in that material or in the Appropriate Legal
371
+ Notices displayed by works containing it; or
372
+
373
+ c) Prohibiting misrepresentation of the origin of that material, or
374
+ requiring that modified versions of such material be marked in
375
+ reasonable ways as different from the original version; or
376
+
377
+ d) Limiting the use for publicity purposes of names of licensors or
378
+ authors of the material; or
379
+
380
+ e) Declining to grant rights under trademark law for use of some
381
+ trade names, trademarks, or service marks; or
382
+
383
+ f) Requiring indemnification of licensors and authors of that
384
+ material by anyone who conveys the material (or modified versions of
385
+ it) with contractual assumptions of liability to the recipient, for
386
+ any liability that these contractual assumptions directly impose on
387
+ those licensors and authors.
388
+
389
+ All other non-permissive additional terms are considered "further
390
+ restrictions" within the meaning of section 10. If the Program as you
391
+ received it, or any part of it, contains a notice stating that it is
392
+ governed by this License along with a term that is a further
393
+ restriction, you may remove that term. If a license document contains
394
+ a further restriction but permits relicensing or conveying under this
395
+ License, you may add to a covered work material governed by the terms
396
+ of that license document, provided that the further restriction does
397
+ not survive such relicensing or conveying.
398
+
399
+ If you add terms to a covered work in accord with this section, you
400
+ must place, in the relevant source files, a statement of the
401
+ additional terms that apply to those files, or a notice indicating
402
+ where to find the applicable terms.
403
+
404
+ Additional terms, permissive or non-permissive, may be stated in the
405
+ form of a separately written license, or stated as exceptions;
406
+ the above requirements apply either way.
407
+
408
+ 8. Termination.
409
+
410
+ You may not propagate or modify a covered work except as expressly
411
+ provided under this License. Any attempt otherwise to propagate or
412
+ modify it is void, and will automatically terminate your rights under
413
+ this License (including any patent licenses granted under the third
414
+ paragraph of section 11).
415
+
416
+ However, if you cease all violation of this License, then your
417
+ license from a particular copyright holder is reinstated (a)
418
+ provisionally, unless and until the copyright holder explicitly and
419
+ finally terminates your license, and (b) permanently, if the copyright
420
+ holder fails to notify you of the violation by some reasonable means
421
+ prior to 60 days after the cessation.
422
+
423
+ Moreover, your license from a particular copyright holder is
424
+ reinstated permanently if the copyright holder notifies you of the
425
+ violation by some reasonable means, this is the first time you have
426
+ received notice of violation of this License (for any work) from that
427
+ copyright holder, and you cure the violation prior to 30 days after
428
+ your receipt of the notice.
429
+
430
+ Termination of your rights under this section does not terminate the
431
+ licenses of parties who have received copies or rights from you under
432
+ this License. If your rights have been terminated and not permanently
433
+ reinstated, you do not qualify to receive new licenses for the same
434
+ material under section 10.
435
+
436
+ 9. Acceptance Not Required for Having Copies.
437
+
438
+ You are not required to accept this License in order to receive or
439
+ run a copy of the Program. Ancillary propagation of a covered work
440
+ occurring solely as a consequence of using peer-to-peer transmission
441
+ to receive a copy likewise does not require acceptance. However,
442
+ nothing other than this License grants you permission to propagate or
443
+ modify any covered work. These actions infringe copyright if you do
444
+ not accept this License. Therefore, by modifying or propagating a
445
+ covered work, you indicate your acceptance of this License to do so.
446
+
447
+ 10. Automatic Licensing of Downstream Recipients.
448
+
449
+ Each time you convey a covered work, the recipient automatically
450
+ receives a license from the original licensors, to run, modify and
451
+ propagate that work, subject to this License. You are not responsible
452
+ for enforcing compliance by third parties with this License.
453
+
454
+ An "entity transaction" is a transaction transferring control of an
455
+ organization, or substantially all assets of one, or subdividing an
456
+ organization, or merging organizations. If propagation of a covered
457
+ work results from an entity transaction, each party to that
458
+ transaction who receives a copy of the work also receives whatever
459
+ licenses to the work the party's predecessor in interest had or could
460
+ give under the previous paragraph, plus a right to possession of the
461
+ Corresponding Source of the work from the predecessor in interest, if
462
+ the predecessor has it or can get it with reasonable efforts.
463
+
464
+ You may not impose any further restrictions on the exercise of the
465
+ rights granted or affirmed under this License. For example, you may
466
+ not impose a license fee, royalty, or other charge for exercise of
467
+ rights granted under this License, and you may not initiate litigation
468
+ (including a cross-claim or counterclaim in a lawsuit) alleging that
469
+ any patent claim is infringed by making, using, selling, offering for
470
+ sale, or importing the Program or any portion of it.
471
+
472
+ 11. Patents.
473
+
474
+ A "contributor" is a copyright holder who authorizes use under this
475
+ License of the Program or a work on which the Program is based. The
476
+ work thus licensed is called the contributor's "contributor version".
477
+
478
+ A contributor's "essential patent claims" are all patent claims
479
+ owned or controlled by the contributor, whether already acquired or
480
+ hereafter acquired, that would be infringed by some manner, permitted
481
+ by this License, of making, using, or selling its contributor version,
482
+ but do not include claims that would be infringed only as a
483
+ consequence of further modification of the contributor version. For
484
+ purposes of this definition, "control" includes the right to grant
485
+ patent sublicenses in a manner consistent with the requirements of
486
+ this License.
487
+
488
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
489
+ patent license under the contributor's essential patent claims, to
490
+ make, use, sell, offer for sale, import and otherwise run, modify and
491
+ propagate the contents of its contributor version.
492
+
493
+ In the following three paragraphs, a "patent license" is any express
494
+ agreement or commitment, however denominated, not to enforce a patent
495
+ (such as an express permission to practice a patent or covenant not to
496
+ sue for patent infringement). To "grant" such a patent license to a
497
+ party means to make such an agreement or commitment not to enforce a
498
+ patent against the party.
499
+
500
+ If you convey a covered work, knowingly relying on a patent license,
501
+ and the Corresponding Source of the work is not available for anyone
502
+ to copy, free of charge and under the terms of this License, through a
503
+ publicly available network server or other readily accessible means,
504
+ then you must either (1) cause the Corresponding Source to be so
505
+ available, or (2) arrange to deprive yourself of the benefit of the
506
+ patent license for this particular work, or (3) arrange, in a manner
507
+ consistent with the requirements of this License, to extend the patent
508
+ license to downstream recipients. "Knowingly relying" means you have
509
+ actual knowledge that, but for the patent license, your conveying the
510
+ covered work in a country, or your recipient's use of the covered work
511
+ in a country, would infringe one or more identifiable patents in that
512
+ country that you have reason to believe are valid.
513
+
514
+ If, pursuant to or in connection with a single transaction or
515
+ arrangement, you convey, or propagate by procuring conveyance of, a
516
+ covered work, and grant a patent license to some of the parties
517
+ receiving the covered work authorizing them to use, propagate, modify
518
+ or convey a specific copy of the covered work, then the patent license
519
+ you grant is automatically extended to all recipients of the covered
520
+ work and works based on it.
521
+
522
+ A patent license is "discriminatory" if it does not include within
523
+ the scope of its coverage, prohibits the exercise of, or is
524
+ conditioned on the non-exercise of one or more of the rights that are
525
+ specifically granted under this License. You may not convey a covered
526
+ work if you are a party to an arrangement with a third party that is
527
+ in the business of distributing software, under which you make payment
528
+ to the third party based on the extent of your activity of conveying
529
+ the work, and under which the third party grants, to any of the
530
+ parties who would receive the covered work from you, a discriminatory
531
+ patent license (a) in connection with copies of the covered work
532
+ conveyed by you (or copies made from those copies), or (b) primarily
533
+ for and in connection with specific products or compilations that
534
+ contain the covered work, unless you entered into that arrangement,
535
+ or that patent license was granted, prior to 28 March 2007.
536
+
537
+ Nothing in this License shall be construed as excluding or limiting
538
+ any implied license or other defenses to infringement that may
539
+ otherwise be available to you under applicable patent law.
540
+
541
+ 12. No Surrender of Others' Freedom.
542
+
543
+ If conditions are imposed on you (whether by court order, agreement or
544
+ otherwise) that contradict the conditions of this License, they do not
545
+ excuse you from the conditions of this License. If you cannot convey a
546
+ covered work so as to satisfy simultaneously your obligations under this
547
+ License and any other pertinent obligations, then as a consequence you may
548
+ not convey it at all. For example, if you agree to terms that obligate you
549
+ to collect a royalty for further conveying from those to whom you convey
550
+ the Program, the only way you could satisfy both those terms and this
551
+ License would be to refrain entirely from conveying the Program.
552
+
553
+ 13. Use with the GNU Affero General Public License.
554
+
555
+ Notwithstanding any other provision of this License, you have
556
+ permission to link or combine any covered work with a work licensed
557
+ under version 3 of the GNU Affero General Public License into a single
558
+ combined work, and to convey the resulting work. The terms of this
559
+ License will continue to apply to the part which is the covered work,
560
+ but the special requirements of the GNU Affero General Public License,
561
+ section 13, concerning interaction through a network will apply to the
562
+ combination as such.
563
+
564
+ 14. Revised Versions of this License.
565
+
566
+ The Free Software Foundation may publish revised and/or new versions of
567
+ the GNU General Public License from time to time. Such new versions will
568
+ be similar in spirit to the present version, but may differ in detail to
569
+ address new problems or concerns.
570
+
571
+ Each version is given a distinguishing version number. If the
572
+ Program specifies that a certain numbered version of the GNU General
573
+ Public License "or any later version" applies to it, you have the
574
+ option of following the terms and conditions either of that numbered
575
+ version or of any later version published by the Free Software
576
+ Foundation. If the Program does not specify a version number of the
577
+ GNU General Public License, you may choose any version ever published
578
+ by the Free Software Foundation.
579
+
580
+ If the Program specifies that a proxy can decide which future
581
+ versions of the GNU General Public License can be used, that proxy's
582
+ public statement of acceptance of a version permanently authorizes you
583
+ to choose that version for the Program.
584
+
585
+ Later license versions may give you additional or different
586
+ permissions. However, no additional obligations are imposed on any
587
+ author or copyright holder as a result of your choosing to follow a
588
+ later version.
589
+
590
+ 15. Disclaimer of Warranty.
591
+
592
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
593
+ APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
594
+ HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
595
+ OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
596
+ THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
597
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
598
+ IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
599
+ ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
600
+
601
+ 16. Limitation of Liability.
602
+
603
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
604
+ WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
605
+ THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
606
+ GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
607
+ USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
608
+ DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
609
+ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
610
+ EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
611
+ SUCH DAMAGES.
612
+
613
+ 17. Interpretation of Sections 15 and 16.
614
+
615
+ If the disclaimer of warranty and limitation of liability provided
616
+ above cannot be given local legal effect according to their terms,
617
+ reviewing courts shall apply local law that most closely approximates
618
+ an absolute waiver of all civil liability in connection with the
619
+ Program, unless a warranty or assumption of liability accompanies a
620
+ copy of the Program in return for a fee.
621
+
622
+ END OF TERMS AND CONDITIONS
623
+
624
+ How to Apply These Terms to Your New Programs
625
+
626
+ If you develop a new program, and you want it to be of the greatest
627
+ possible use to the public, the best way to achieve this is to make it
628
+ free software which everyone can redistribute and change under these terms.
629
+
630
+ To do so, attach the following notices to the program. It is safest
631
+ to attach them to the start of each source file to most effectively
632
+ state the exclusion of warranty; and each file should have at least
633
+ the "copyright" line and a pointer to where the full notice is found.
634
+
635
+ <one line to give the program's name and a brief idea of what it does.>
636
+ Copyright (C) <year> <name of author>
637
+
638
+ This program is free software: you can redistribute it and/or modify
639
+ it under the terms of the GNU General Public License as published by
640
+ the Free Software Foundation, either version 3 of the License, or
641
+ (at your option) any later version.
642
+
643
+ This program is distributed in the hope that it will be useful,
644
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
645
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
646
+ GNU General Public License for more details.
647
+
648
+ You should have received a copy of the GNU General Public License
649
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
650
+
651
+ Also add information on how to contact you by electronic and paper mail.
652
+
653
+ If the program does terminal interaction, make it output a short
654
+ notice like this when it starts in an interactive mode:
655
+
656
+ <program> Copyright (C) <year> <name of author>
657
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
658
+ This is free software, and you are welcome to redistribute it
659
+ under certain conditions; type `show c' for details.
660
+
661
+ The hypothetical commands `show w' and `show c' should show the appropriate
662
+ parts of the General Public License. Of course, your program's commands
663
+ might be different; for a GUI interface, you would use an "about box".
664
+
665
+ You should also get your employer (if you work as a programmer) or school,
666
+ if any, to sign a "copyright disclaimer" for the program, if necessary.
667
+ For more information on this, and how to apply and follow the GNU GPL, see
668
+ <http://www.gnu.org/licenses/>.
669
+
670
+ The GNU General Public License does not permit incorporating your program
671
+ into proprietary programs. If your program is a subroutine library, you
672
+ may consider it more useful to permit linking proprietary applications with
673
+ the library. If this is what you want to do, use the GNU Lesser General
674
+ Public License instead of this License. But first, please read
675
+ <http://www.gnu.org/philosophy/why-not-lgpl.html>.
676
+
data/NEWS ADDED
@@ -0,0 +1,2 @@
1
+ Version 0.1
2
+ - Initial release
data/README ADDED
@@ -0,0 +1,11 @@
1
+ phpdocr is a simple way to access PHP documentation from php.net from the
2
+ command-line.
3
+
4
+ It will download, prettify, and output PHP documentation for the
5
+ function/class/.. that was supplied on the command-line, much like perldoc(1)
6
+ does for perl(1) and ri does for ruby(1). Unless you explicitly tell it not to,
7
+ phpdocr will also cache the documentation locally for fast retrieval in the
8
+ future.
9
+
10
+ phpdocr will send its output to your PAGER (if it is set, otherwise it will
11
+ default to less).
data/phpdocr ADDED
@@ -0,0 +1,528 @@
1
+ #!/usr/bin/ruby
2
+ # phpdocr
3
+ # Copyright (C) Eskild Hustvedt 2009
4
+ #
5
+ # This program is free software: you can redistribute it and/or modify
6
+ # it under the terms of the GNU General Public License as published by
7
+ # the Free Software Foundation, either version 3 of the License, or
8
+ # (at your option) any later version.
9
+ #
10
+ # This program is distributed in the hope that it will be useful,
11
+ # but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
+ # GNU General Public License for more details.
14
+ #
15
+ # You should have received a copy of the GNU General Public License
16
+ # along with this program. If not, see <http://www.gnu.org/licenses/>.
17
+
18
+ # Fetch from rubygems if available
19
+ require 'rubygems'
20
+ # Command-line parsing
21
+ require 'getoptlong'
22
+ # To run the prettifier
23
+ require 'open3'
24
+ # To create a temporary file with HTML
25
+ require 'tempfile'
26
+ # CGI is used for escaping
27
+ require 'cgi'
28
+ # www-mechanize is used for fetching from HTTP
29
+ require 'mechanize'
30
+ # For creating the cache dir if needed
31
+ require 'fileutils'
32
+ # Application version
33
+ $version = 0.1
34
+ # Bool, true if we should include the user notes section
35
+ $includeUserNotes = false
36
+ # Verbose mode (true/false)
37
+ $verbose = false
38
+ # Cache enabled?
39
+ $cache = true
40
+ # php.net mirror
41
+ $mirror = 'php.net'
42
+
43
+ # Purpose: Print formatted --help output
44
+ # Usage: printHelp('-shortoption', '--longoption', 'description');
45
+ # Description will be reformatted to fit within a normal terminal
46
+ def printHelp (short,long,description)
47
+ maxlen = 80
48
+ optionlen = 20
49
+ # Check if the short/long are LONGER than optionlen, if so, we need
50
+ # to do some additional magic to take up only $maxlen.
51
+ # The +1 here is because we always add a space between them, no matter what
52
+ if (short.length + long.length + 1) > optionlen
53
+ optionlen = short.length + long.length + 1;
54
+ end
55
+
56
+ generatedDesc = ''
57
+ currdesc = ''
58
+
59
+ description.split(/ /).each do |part|
60
+ if(generatedDesc.length > 0)
61
+ if (currdesc.length + part.length + 1 + 20) > maxlen
62
+ generatedDesc.concat("\n")
63
+ currdesc = ''
64
+ else
65
+ currdesc.concat(' ')
66
+ generatedDesc.concat(' ')
67
+ end
68
+ end
69
+ currdesc.concat(part)
70
+ generatedDesc.concat(part)
71
+ end
72
+ if !(generatedDesc.length > 0)
73
+ raise("Option mismatch")
74
+ end
75
+ generatedDesc.split(/\n/).each do |descr|
76
+ printf("%-4s %-15s %s\n",short,long,descr)
77
+ short = ''; long = ''
78
+ end
79
+ end
80
+
81
+ # Purpose: Print the help output
82
+ def Help ()
83
+ puts "phpdocr "+$version.to_s
84
+ puts ""
85
+ puts "Usage: phpdocr [OPTIONS] [FUNCTION/CLASS/SEARCH STRING/..]"
86
+ puts ""
87
+ printHelp('-h','--help','Display this help text')
88
+ printHelp('-u','--comments','Include the user comments part of the documentation in output')
89
+ printHelp('-n','--no-cache','Disable the local doc cache (~/.phpdocr/)')
90
+ printHelp('-v','--verbose','Enable verbose mode')
91
+ printHelp('-m','--mirror','Use the supplied mirror of php.net')
92
+ printHelp('','--version','Output the phpdocr version and exit')
93
+ printHelp('','--man','Show the phpdocr manpage')
94
+ end
95
+
96
+ # Purpose: Output a string if in verbose mode
97
+ def vputs (str)
98
+ if $verbose
99
+ puts(str)
100
+ end
101
+ end
102
+
103
+ # Purpose: Show the manpage
104
+ def showManPage ()
105
+ if ! inPath('man')
106
+ puts
107
+ puts "You don't appear to have the 'man' program installed."
108
+ puts "Please install it, then re-run phpdocr --man"
109
+ exit(0)
110
+ end
111
+ mySelf = File.expand_path($0)
112
+ while File.symlink?(mySelf)
113
+ mySelf = File.readlink(mySelf)
114
+ end
115
+ sourceDir = '.'
116
+ if mySelf != nil
117
+ sourceDir = File.dirname(mySelf)
118
+ end
119
+ dirs = [sourceDir]
120
+ if ENV['MANPATH']
121
+ dirs.concat(ENV['MANPATH'].split(':'))
122
+ end
123
+ dirs.push('./')
124
+ dirs.each do |dir|
125
+ [ 'phpdocr.1','man1/phpdocr.1','man1/phpdocr.1.gz','man1/phpdocr.1.bz2','man1/phpdocr.1.lzma'].each do |manFile|
126
+ if File.exists?(dir+'/'+manFile)
127
+ exec('man',dir+'/'+manFile)
128
+ end
129
+ end
130
+ end
131
+ puts
132
+ puts 'phpdocr failed to locate its manpage.'
133
+ puts 'Run the following command to view it:'
134
+ puts '\curl -s "http://github.com/zerodogg/phpdocr/raw/master/phpdocr.1" | groff -T utf8 -man | \less'
135
+ end
136
+
137
+ # Purpose: Print debugging info
138
+ def debugInfo ()
139
+ puts "phpdocr "+$version.to_s
140
+ begin
141
+ if inPath('md5sum')
142
+ outStr = nil
143
+ out = IO.popen('md5sum '+File.expand_path($0))
144
+ outStr = out.readline
145
+ outStr.sub!(/\s+.*$/,'')
146
+ puts('md5sum: '+outStr)
147
+ end
148
+ rescue
149
+ puts('(exception while generating md5sum: '+$!+')')
150
+ end
151
+ prettifierCmd = prettifier('path',false)
152
+ if prettifierCmd == nil
153
+ prettifierCmd = '(missing)'
154
+ else
155
+ prettifierCmd = String.new(prettifierCmd.join(' '))
156
+ end
157
+ puts 'Prettifier: '+prettifierCmd
158
+ exit(0)
159
+ end
160
+
161
+ # Fetch a URL and return its contents
162
+ def getURL (url)
163
+ begin
164
+ www = WWW::Mechanize.new
165
+ vputs('Downloading '+url)
166
+ return www.get(url).body
167
+ rescue
168
+ return ''
169
+ end
170
+ end
171
+
172
+ # Purpose: Check for a file in path
173
+ def inPath(exec)
174
+ ENV['PATH'].split(/:/).each do |part|
175
+ if File.executable?(part+'/'+exec) and not File.directory?(part+'/'+exec)
176
+ return true
177
+ end
178
+ end
179
+ return false
180
+ end
181
+
182
+ # Purpose: Detect and run a prettifier
183
+ def prettifier (path, missingIsFatal = true)
184
+ # Links family, they use basically the same syntax, but we append
185
+ # -no-references for elinks.
186
+ if inPath('elinks')
187
+ return [ 'elinks','-force-html','-no-references','-dump',path ]
188
+ end
189
+ ['links2', 'links' ].each do |links|
190
+ if inPath(links)
191
+ return [ links,'-force-html','-dump',path ]
192
+ end
193
+ end
194
+
195
+ # w3m
196
+ if inPath('w3m')
197
+ return ['w3m','-dump','-T','text/html',path]
198
+ end
199
+
200
+ # html2text
201
+ if inPath('html2text')
202
+ return ['html2text','-style','pretty',path ]
203
+ end
204
+
205
+ # Finally, try lynx
206
+ if inPath('lynx')
207
+ return ['lynx','-dump','-force_html',path ]
208
+ end
209
+
210
+ if missingIsFatal
211
+ # If we found none, then give up
212
+ puts
213
+ puts "Failed to locate any HTML parser. Please install one of the following,"
214
+ puts "and then re-run phpdocr: elinks, links2, links, w3m, html2text, lynx"
215
+ exit(1)
216
+ else
217
+ return nil
218
+ end
219
+ end
220
+
221
+ # Purpose: Convert links
222
+ def convertLinks (list)
223
+ result = ''
224
+
225
+ rmlastA = false
226
+ first = true
227
+
228
+ list.split(/</).each do |line|
229
+ if line =~ /^a[^>]+href="\w/
230
+ currlink = String.new(line)
231
+ # Remove the href
232
+ currlink.sub!(/^a[^>]+href="/,'')
233
+ # Remove whatever is after the href
234
+ currlink.sub!(/".*$/,'')
235
+ # Remove '#' links
236
+ currlink.sub!(/#.*$/,'')
237
+ # Parse away .php and function declarations
238
+ currlink.sub!(/\.php$/,'')
239
+ currlink.sub!(/^function\./,'')
240
+ # Remove other HTML
241
+ line.sub!(/^[^>]+>/,'')
242
+ # Add new content
243
+ line = String.new('['+currlink+'] '+line)
244
+ rmlastA = true
245
+ # Remove the a> if rmlastA is true
246
+ elsif line =~ /\/a>/ and rmlastA
247
+ line.sub!(/^\/a>/,'')
248
+ rmlastA = false
249
+ elsif first
250
+ first = false
251
+ else
252
+ line = '<'+line
253
+ end
254
+ result.concat(line)
255
+ end
256
+ return result
257
+ end
258
+
259
+ # Purpose: Attempt to fetch suggestions
260
+ def fetchSuggestions (data)
261
+ final = []
262
+ hadStart = false
263
+ no = 0
264
+ data.split(/\n/).each do |line|
265
+ if line =~ /result list start/
266
+ hadStart = true
267
+ elsif hadStart == false
268
+ next
269
+ elsif line =~ /result list end/
270
+ break
271
+ else
272
+ no += 1
273
+ # Kill all HTML
274
+ line.gsub!(/<[^>]+>/,'')
275
+ if line =~ /\S/
276
+ final.push(line)
277
+ end
278
+ end
279
+ end
280
+ if hadStart && final != nil
281
+ return final
282
+ else
283
+ return nil
284
+ end
285
+ end
286
+
287
+ # Purpose: Display the contents of the supplied string inside the users PAGER
288
+ def pager(contents)
289
+ # Detect the pager
290
+ pager = ENV['PAGER']
291
+ if pager == '' || pager == nil
292
+ pager = 'less'
293
+ end
294
+
295
+ # Write data to the pager
296
+ input = IO.popen(pager,'w')
297
+ begin
298
+ input.puts(contents)
299
+ input.close
300
+ rescue
301
+ end
302
+ end
303
+
304
+ # Purpose: Look up something on the website
305
+ def lookupWeb (name, fetchPattern = true, prevSearch = nil)
306
+ # fetchPattern means we should run a serach
307
+ stringC = String.new(name)
308
+ if fetchPattern == true
309
+ stringC = CGI.escape(name)
310
+ url = 'http://'+$mirror+'/manual-lookup.php?pattern='+name
311
+ else
312
+ # Otherwise, attempt a direct page
313
+ if ! stringC =~ /\.php$/
314
+ stringC.concat('.php')
315
+ end
316
+ url = 'http://'+$mirror+'/manual/en/'+stringC+'.php'
317
+ end
318
+ # Retrieve data
319
+ data = getURL(url)
320
+ # True if this is within the normally returned page
321
+ hadFirst = false
322
+ # True if we have had the UDM statement
323
+ hadUDM = false
324
+ # The result on normal pages
325
+ result = ''
326
+ # The result on index-like pages
327
+ indexResult = ''
328
+ # Parse it
329
+ data.split(/\n/).each do |line|
330
+ if hadFirst
331
+ if ! $includeUserNotes && line =~ /(User Contributed Notes|<div id="usernotes">)/
332
+ break
333
+ end
334
+ result.concat(line)
335
+ elsif line =~ /ect1/
336
+ hadFirst = true
337
+ end
338
+ if hadUDM
339
+ if line =~ /<h1 class="title">/
340
+ indexResult = String.new(line)
341
+ else
342
+ indexResult.concat(line)
343
+ end
344
+ elsif line =~ /UdmComment/
345
+ hadUDM = true
346
+ end
347
+ end
348
+
349
+ # If we got no useful data, try again if possible, else output failure
350
+ if ! hadFirst && ! hadUDM
351
+ # If this was a fetchPattern run, try a direct one
352
+ if fetchPattern
353
+ return lookupWeb(name,false,data)
354
+ else
355
+ # This was a direct one, output errors
356
+ puts
357
+ puts 'Could not find '+name+' in PHP documentation'
358
+ # If we have a previous search value, attempt to fetch suggestions from it
359
+ if prevSearch != nil
360
+ suggest = fetchSuggestions(prevSearch)
361
+ # If we have suggestions, output them.
362
+ if suggest != nil
363
+ puts "\n"
364
+ puts "Perhaps you were looking for one of these?"
365
+ while suggest.length > 0
366
+ printf("%-20s %-20s %-20s %-20s\n",suggest[0],suggest[1],suggest[2],suggest[3])
367
+ 4.times { suggest.shift }
368
+ end
369
+ end
370
+ end
371
+ return
372
+ end
373
+ end
374
+
375
+ # If we 'hadFirst', then result contains what we want, otherwise use
376
+ # indexResult
377
+ if hadFirst
378
+ result = convertLinks(result)
379
+ else
380
+ result = convertLinks(indexResult)
381
+ end
382
+
383
+ # Write the data to a temporary file so the prettifier can
384
+ # read it there (not all of them support reading from STDIN)
385
+ tmp = Tempfile.new('phpdocr')
386
+ tmp.puts('<html><body>'+result+'</body></html>')
387
+ tmp.flush
388
+ cmd = prettifier(tmp.path)
389
+ # Get the output
390
+ Open3.popen3(*cmd) { |stdin, stdout, stderr|
391
+ result = stdout.gets(nil)
392
+ }
393
+
394
+ # Close and remove the temporary file
395
+ tmp.close(true)
396
+
397
+ # Append the url we used to the result
398
+ result.concat("\nRetrieved from "+url)
399
+
400
+ return result
401
+ end
402
+
403
+ # Purpose: Prepare the cache dir
404
+ def prepCacheDir (name)
405
+ cacheDir = ENV['HOME']+'/.phpdocr/'
406
+ if ! File.directory?(cacheDir)
407
+ if File.exists?(cacheDir)
408
+ puts cacheDir+': exists but is not a directory, caching disabled.'
409
+ $cache = false
410
+ return nil
411
+ end
412
+ FileUtils.mkpath(cacheDir)
413
+ end
414
+ name.gsub!(/\//,'')
415
+ filePrefix = 'cache.'
416
+ if $includeUserNotes
417
+ filePrefix = 'cache.withNotes.'
418
+ end
419
+ return cacheDir+filePrefix+name
420
+ end
421
+
422
+ # Purpose: Look something up in the cache
423
+ def lookupCache (name)
424
+ cacheFile = prepCacheDir(name)
425
+ if cacheFile == nil
426
+ return
427
+ end
428
+
429
+ if File.exists?(cacheFile)
430
+ file = File.open(cacheFile)
431
+ vputs('Loaded information for '+name+' from the cache')
432
+ return file.gets(nil)
433
+ end
434
+
435
+ return nil
436
+ end
437
+
438
+ # Purpose: Write something to the cache
439
+ def writeToCache (name,data)
440
+ cacheFile = prepCacheDir(name)
441
+ if cacheFile == nil
442
+ return
443
+ end
444
+ file = File.open(cacheFile,'w')
445
+ file.puts(data)
446
+ file.close
447
+ end
448
+
449
+ # Purpose: Look something up
450
+ def lookup(name)
451
+ result = nil
452
+ sourceWasWeb = false
453
+ if $cache
454
+ result = lookupCache(name)
455
+ end
456
+ if !$cache || result == nil
457
+ sourceWasWeb = true
458
+ result = lookupWeb(name)
459
+ end
460
+ if result != nil
461
+ if $cache && sourceWasWeb
462
+ writeToCache(name,result)
463
+ end
464
+ pager(result)
465
+ end
466
+ end
467
+
468
+ opts = GetoptLong.new(
469
+ [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
470
+ [ '--verbose', '-v', GetoptLong::NO_ARGUMENT ],
471
+ [ '--comments','-u', GetoptLong::NO_ARGUMENT ],
472
+ [ '--no-cache','--nocache','-n', GetoptLong::NO_ARGUMENT ],
473
+ [ '--debuginfo', GetoptLong::NO_ARGUMENT ],
474
+ [ '--version', GetoptLong::NO_ARGUMENT ],
475
+ [ '--mirror', '-m', GetoptLong::REQUIRED_ARGUMENT ],
476
+ [ '--man', GetoptLong::NO_ARGUMENT ]
477
+ )
478
+
479
+ # Handle command-line arguments
480
+ begin
481
+ opts.each do |opt, arg|
482
+ case opt
483
+ when '--help'
484
+ Help()
485
+ exit(0)
486
+ when '--verbose'
487
+ $verbose = true
488
+ when '--comments'
489
+ $includeUserNotes = true
490
+ when '--no-cache'
491
+ $cache = false
492
+ when '--debuginfo'
493
+ debugInfo()
494
+ when '--version'
495
+ puts('phpdocr version '+$version.to_s)
496
+ exit(0)
497
+ when '--mirror'
498
+ $mirror = arg
499
+ when '--man'
500
+ showManPage()
501
+ exit(0)
502
+ end
503
+ end
504
+ rescue
505
+ puts('See --help for more inforation')
506
+ exit(1)
507
+ end
508
+
509
+ if ARGV.length == 0 || ARGV.length > 1
510
+ Help()
511
+ exit(1)
512
+ end
513
+
514
+ begin
515
+ lookup(ARGV.shift)
516
+ rescue => ex
517
+ puts('---')
518
+ puts('Exception: '+ex.to_s)
519
+ puts('Backtrace: '+"\n"+ex.backtrace.join("\n"))
520
+ puts('---')
521
+ puts()
522
+ puts('An exception has occurred and phpdocr can not continue.')
523
+ puts('This almost certainly reflects a bug in phpdocr.')
524
+ puts('Please check that you have the latest version off phpdocr,')
525
+ puts('and if you do, report this issue along with the text between the "---" above');
526
+ puts('to http://random.zerodogg.org/phpdocr/bugs')
527
+ exit(1)
528
+ end
data/phpdocr.1 ADDED
@@ -0,0 +1,102 @@
1
+ .IX Title "PHPDOCR 1"
2
+ .TH PHPDOCR 1 "2009-09-24" "phpdocr 0.1" ""
3
+ .\" For nroff, turn off justification. Always turn off hyphenation; it makes
4
+ .\" way too many mistakes in technical documents.
5
+ .if n .ad l
6
+ .nh
7
+ .SH "NAME"
8
+ phpdocr \- a simple way to access PHP documentation from the command\-line
9
+ .SH "SYNOPSIS"
10
+ .IX Header "SYNOPSIS"
11
+ phpdocr \fI[\s-1OPTIONS\s0]\fR \fI[\s-1FUNCTION/CLASS/SEARCH\s0 \s-1STRING/\s0..]\fR
12
+ .SH "DESCRIPTION"
13
+ .IX Header "DESCRIPTION"
14
+ \&\fBphpdocr\fR is a simple way to access \s-1PHP\s0 documentation from php.net
15
+ from the command-line.
16
+ .PP
17
+ It will download, prettify, and output \s-1PHP\s0 documentation for the
18
+ function/class/.. that was supplied on the command-line, much like
19
+ \&\fIperldoc\fR\|(1) does for \fIperl\fR\|(1) and ri does for \fIruby\fR\|(1). Unless you explicitly
20
+ tell it not to, phpdocr will also cache the documentation locally
21
+ for fast retrieval in the future.
22
+ .PP
23
+ phpdocr will send its output to your \s-1PAGER\s0 (if it is set, otherwise
24
+ it will default to less).
25
+ .PP
26
+ Links to further information are displayed in the output as [link\-text].
27
+ The link-text can be supplied to phpdocr in a subsequent invocation to
28
+ get more detailed information on that subject.
29
+ .SH "OPTIONS"
30
+ .IX Header "OPTIONS"
31
+ .IP "\fB\-h, \-\-help\fR" 4
32
+ .IX Item "-h, --help"
33
+ Display the help screen
34
+ .IP "\fB\-v, \-\-verbose\fR" 4
35
+ .IX Item "-v, --verbose"
36
+ Increase verbosity. When this is present phpdocr will tell you additional
37
+ information about what it is doing, ie. what page it is downloading at the
38
+ moment.
39
+ .IP "\fB\-o, \-\-comments\fR" 4
40
+ .IX Item "-o, --comments"
41
+ php.net has comments associated with most pages. By default phpdocr will
42
+ filter these away, however some times you may want to see them, in that
43
+ case supply \-\-comments and phpdocr will include them in its output.
44
+ .IP "\fB\-n, \-\-no\-cache\fR" 4
45
+ .IX Item "-n, --no-cache"
46
+ By default, phpdocr will cache documentation locally so that it can
47
+ easily be retrieved later without having to re-download it. This
48
+ parameter disables all caching (both reading from the cache, and
49
+ writing to the cache).
50
+ .IP "\fB\-m, \-\-mirror\fR \fI\s-1PATH\s0\fR" 4
51
+ .IX Item "-m, --mirror PATH"
52
+ By default phpdocr will connect to php.net. Use this to make it connect
53
+ to a specific mirror instead (ie. no2.php.net).
54
+ .IP "\fB\-\-man\fR" 4
55
+ .IX Item "--man"
56
+ Show the manpage. Normally 'man phpdocr' would do, but when phpdocr is
57
+ installed from a rubygem the phpdocr manpage isn't placed anywhere
58
+ in \fIman\fR\|(1)'s path, this will autodetect its location and issue man
59
+ directly on the phpdocr.1 file (and thus work even when 'man phpdocr'
60
+ does not).
61
+ .SH "FILES"
62
+ .IX Header "FILES"
63
+ \&\fI~/.phpdocr\fR \- this is where phpdocr will store any cached documentation.
64
+ It is safe to remove this directory, or any of its contents, at any time
65
+ if you need the disk space. phpdocr will simply re-download the documentation
66
+ next time you request it.
67
+ .SH "EXAMPLES"
68
+ .IX Header "EXAMPLES"
69
+ .IP "\fIphpdocr date\fR" 4
70
+ .IX Item "phpdocr date"
71
+ Will download and output the documentation for the date function, or
72
+ load it from cache if it has been cached.
73
+ .IP "\fIphpdocr \-u localtime\fR" 4
74
+ .IX Item "phpdocr -u localtime"
75
+ Will download and output the documentation for the localtime function
76
+ and the user comments associated with it. If an entry of the localtime
77
+ documentation with comments is already in cache, it will load it from
78
+ there instead.
79
+ .IP "\fIphpdocr \-n foreach\fR" 4
80
+ .IX Item "phpdocr -n foreach"
81
+ Will download and output the documentation for the foreach construct,
82
+ ignoring any cached information and not writing the result to the cache.
83
+ .SH "DEPENDENCIES"
84
+ .IX Header "DEPENDENCIES"
85
+ Requires one of: elinks, links2, links, w3m, html2text or lynx for \s-1HTML\s0 parsing.
86
+ .PP
87
+ Requires the mechanize rubygem for fetching stuff over \s-1HTTP\s0.
88
+ .SH "HELP/SUPPORT"
89
+ .IX Header "HELP/SUPPORT"
90
+ If you need help or support please visit the website at <http://random.zerodogg.org/phpdocr>
91
+ .SH "BUGS AND LIMITATIONS"
92
+ .IX Header "BUGS AND LIMITATIONS"
93
+ If you find a bug, please report it at <http://random.zerodogg.org/phpdocr/bugs>
94
+ .SH "AUTHOR"
95
+ .IX Header "AUTHOR"
96
+ \&\fBphpdocr\fR is written by Eskild Hustvedt <\fIcode at zerodogg dot org\fR>
97
+ .SH "LICENSE AND COPYRIGHT"
98
+ .IX Header "LICENSE AND COPYRIGHT"
99
+ Copyright (C) Eskild Hustvedt 2009
100
+ .PP
101
+ This is free software; see the source for copying conditions. There is \s-1NO\s0
102
+ warranty; not even for \s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.
metadata ADDED
@@ -0,0 +1,67 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: zerodogg-phpdocr
3
+ version: !ruby/object:Gem::Version
4
+ version: "0.1"
5
+ platform: ruby
6
+ authors:
7
+ - Eskild Hustvedt
8
+ autorequire:
9
+ bindir: .
10
+ cert_chain: []
11
+
12
+ date: 2009-09-25 00:00:00 -07:00
13
+ default_executable:
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: mechanize
17
+ type: :runtime
18
+ version_requirement:
19
+ version_requirements: !ruby/object:Gem::Requirement
20
+ requirements:
21
+ - - ">="
22
+ - !ruby/object:Gem::Version
23
+ version: "0"
24
+ version:
25
+ description: A simple way to access PHP documentation from the command-line
26
+ email: code at zerodogg dot org
27
+ executables:
28
+ - phpdocr
29
+ extensions: []
30
+
31
+ extra_rdoc_files: []
32
+
33
+ files:
34
+ - phpdocr
35
+ - README
36
+ - COPYING
37
+ - NEWS
38
+ - phpdocr.1
39
+ has_rdoc: false
40
+ homepage: http://random.zerodogg.org/phpdocr
41
+ licenses:
42
+ post_install_message:
43
+ rdoc_options: []
44
+
45
+ require_paths:
46
+ - lib
47
+ required_ruby_version: !ruby/object:Gem::Requirement
48
+ requirements:
49
+ - - ">="
50
+ - !ruby/object:Gem::Version
51
+ version: "0"
52
+ version:
53
+ required_rubygems_version: !ruby/object:Gem::Requirement
54
+ requirements:
55
+ - - ">="
56
+ - !ruby/object:Gem::Version
57
+ version: "0"
58
+ version:
59
+ requirements:
60
+ - "Either of: elinks, links2, links, w3m, html2text or lynx"
61
+ rubyforge_project:
62
+ rubygems_version: 1.3.5
63
+ signing_key:
64
+ specification_version: 2
65
+ summary: A simple way to access PHP documentation from the command-line
66
+ test_files: []
67
+