emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/devhelp 2e257e2d12 01/13: Add devhelp.el, README.org and C


From: ELPA Syncer
Subject: [nongnu] elpa/devhelp 2e257e2d12 01/13: Add devhelp.el, README.org and COPYING
Date: Sun, 27 Nov 2022 15:59:11 -0500 (EST)

branch: elpa/devhelp
commit 2e257e2d1271d88f09fd09661ba4b705febc1b3c
Author: Akib Azmain Turja <akib@disroot.org>
Commit: Akib Azmain Turja <akib@disroot.org>

    Add devhelp.el, README.org and COPYING
---
 COPYING    | 674 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.org |  48 +++++
 devhelp.el | 597 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 1319 insertions(+)

diff --git a/COPYING b/COPYING
new file mode 100644
index 0000000000..f288702d2f
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.  We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors.  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights.  Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received.  You must make sure that they, too, receive
+or can get the source code.  And you must show them these terms so they
+know their rights.
+
+  Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+  For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software.  For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+  Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so.  This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software.  The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable.  Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products.  If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+  Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary.  To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Use with the GNU Affero General Public License.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+    <program>  Copyright (C) <year>  <name of author>
+    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU GPL, see
+<https://www.gnu.org/licenses/>.
+
+  The GNU General Public License does not permit incorporating your program
+into proprietary programs.  If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.  But first, please read
+<https://www.gnu.org/licenses/why-not-lgpl.html>.
diff --git a/README.org b/README.org
new file mode 100644
index 0000000000..b27390c52c
--- /dev/null
+++ b/README.org
@@ -0,0 +1,48 @@
+#+title: Devhelp - Browse documentation in Devhelp format
+
+In this unfortunate world, many documentations are using various HTML based
+format, instead of using the excellent Texinfo and Info format.  This makes
+integrating of these manuals with Emacs hard, although not impossible.
+
+This package make tries to integrate one of those stupid formats, Devhelp,
+with Emacs.
+
+* Usage
+
+=M-x devhelp= and you are good to go.  But you use a system that isn't FHS
+(Filesystem Hierarchy Standard) compliant, then you would need to change
+it.  For example, you have to put the following in the init file for GNU
+Guix:
+
+#+begin_src emacs-lisp
+(setq devhelp-search-directories
+      '("/run/current-system/profile/share/doc/"
+        "/run/current-system/profile/share/gtk-doc/html/"
+        "~/.guix-profile/share/doc/"
+        "~/.guix-profile/share/gtk-doc/html/"))
+#+end_src
+
+You can also bookmark pages, with the standard ~bookmark-set~ function.
+
+* Installation
+
+Devhelp isn't available on any ELPA right now.  So, you have to follow one
+of the following methods:
+
+** Quelpa
+
+#+begin_src emacs-lisp
+(quelpa '(devhelp :fetcher git
+                  :url "https://codeberg.org/akib/emacs-devhelp.git";))
+#+end_src
+
+** Straight.el
+
+#+begin_src emacs-lisp
+(straight-use-package
+ '(devhelp :type git :repo "https://codeberg.org/akib/emacs-devhelp.git";))
+#+end_src
+
+** Manual
+
+Download the ~devhelp.el~ file and put it in your ~load-path~.
diff --git a/devhelp.el b/devhelp.el
new file mode 100644
index 0000000000..18433eb97c
--- /dev/null
+++ b/devhelp.el
@@ -0,0 +1,597 @@
+;;; devhelp.el --- Browse documentation in Devhelp format  -*- 
lexical-binding: t; -*-
+
+;; Copyright (C) 2022 Akib Azmain Turja.
+
+;; Author: Akib Azmain Turja <akib@disroot.org>
+;; Created: 2022-07-26
+;; Version: 0.1
+;; Package-Requires: ((emacs "27.1"))
+;; Keywords: convenience
+;; URL: https://codeberg.org/akib/emacs-devhelp
+
+;; This file is not part of GNU Emacs.
+
+;; This file is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 3, or (at your option)
+;; any later version.
+
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; For a full copy of the GNU General Public License
+;; see <https://www.gnu.org/licenses/>.
+
+;;; Commentary:
+
+;; In this unfortunate world, many documentations are using various HTML
+;; based format, instead of using the excellent Texinfo and Info format.
+;; This makes integrating of these manuals with Emacs hard, although not
+;; impossible.
+
+;; This package make tries to integrate one of those stupid formats,
+;; Devhelp, with Emacs.
+
+;; Usage
+;; -----
+
+;; M-x devhelp and you are good to go.  But you use a system that isn't FHS
+;; (Filesystem Hierarchy Standard) compliant, then you would need to change
+;; it.  For example, you have to put the following in the init file for GNU
+;; Guix:
+
+;;     (setq devhelp-search-directories
+;;           '("/run/current-system/profile/share/doc/"
+;;             "/run/current-system/profile/share/gtk-doc/html/"
+;;             "~/.guix-profile/share/doc/"
+;;             "~/.guix-profile/share/gtk-doc/html/"))
+
+;; You can also bookmark pages, with the standard `bookmark-set' function.
+
+;;; Code:
+
+(eval-when-compile (require 'cl-lib))
+(require 'dom)
+(require 'shr)
+(require 'bookmark)
+
+(defgroup devhelp nil
+  "Browse documentation in Devhelp format."
+  :group 'convenience
+  :link '(url-link "https://codeberg.org/akib/emacs-devhelp";)
+  :prefix "devhelp-")
+
+(defcustom devhelp-use-variable-pitch-font t
+  "Non-nil means use variable pitch (proportional) font."
+  :type 'boolean)
+
+(defcustom devhelp-text-width nil
+  "Window width to use for HTML rendering.
+
+Integer means use that many columns.  Nil means use full window width."
+  :type '(choice (integer :tag "Fixed width in characters")
+                (const :tag "Use the width of the window" nil)))
+
+(defcustom devhelp-toc-group-books-by-language t
+  "Non-nil means group books by language in table of contents."
+  :type 'boolean)
+
+(defcustom devhelp-index-group-keywords-by-type t
+  "Non-nil means group keywords by type in index."
+  :type 'boolean)
+
+(defcustom devhelp-search-directories
+  '("/usr/share/doc/" "/usr/share/gtk-doc/html/" "/usr/local/share/doc/"
+    "/usr/local/share/gtk-doc/html/")
+  "List of directories to search for Devhelp books.
+
+Note that on GNU Guix, Nix or other FHS (Filesystem Hierarchy Standard)
+non-compliant distributions, the default value won't work.  For GNU Guix,
+set it to '(\"/run/current-system/profile/share/doc/\"
+\"/run/current-system/profile/share/gtk-doc/html/\"
+\"~/.guix-profile/share/doc/\" \"~/.guix-profile/share/gtk-doc/html/\")."
+  :type '(repeat directory))
+
+(defvar devhelp--books nil
+  "Necessary data extracted from Devhelp file.
+
+Each element is a list returned by `devhelp--parse-devhelp-file'.")
+
+(defvar devhelp--history nil
+  "History of pages visited by the user.
+
+The value is of form (CURRENT . STACK), where STACK is the stack of user
+visited pages, and CURRENT is the index of current page in STACK.  Each
+element of STACK is a list of form (TITLE FILE BUFFERPOS), where TITLE is
+the title of the page, FILE is the FILE name followed by optional target
+\(see `url-generic-parse-url') and BUFFERPOS is the position in buffer.
+FILE can also be the symbol `toc', meaning the table of contents page.")
+
+(defun devhelp--parse-devhelp-file (file)
+  "Parse Devhelp file FILE and return book data.
+
+Return a list of form (TITLE NAME LANGUAGE PATH CHAPTERS KEYWORDS), where
+TITLE is the title of book, NAME is the name of the book, LANGUAGE is the
+ programming language name, PATH is the absolute path to it, CHAPTER is a
+list of form (SECTION...) and KEYWORDS is a list of form (KEYWORD...).
+SECTION is a list of form (NAME PATH SUB-SECTIONS...), where NAME is the
+name of the section, PATH is the absolute path to the file and SUB-SECTION
+is a list of form (SECTION...).  KEYWORD is a list of (NAME TYPE PATH),
+where NAME  the keyword name, TYPE is the type of keyword and PATH is the
+absolute path to it."
+  (unless (fboundp 'libxml-parse-html-region)
+    (error "This function requires Emacs to be compiled with libxml2"))
+  (let* ((dom (with-temp-buffer
+                (insert-file-contents file)
+                (libxml-parse-xml-region (point-min) (point-max))))
+         (version (pcase (if (string= (file-name-extension file) "gz")
+                             (file-name-extension
+                              (file-name-sans-extension file))
+                           (file-name-extension file))
+                    ("devhelp" 1)
+                    ("devhelp2" 2)
+                    (_ (error "Invalid Devhelp file"))))
+         (base (expand-file-name (or (dom-attr dom 'base) "")
+                                 (file-name-directory file))))
+    (cl-labels ((children-by-tag
+                 (tree tag)
+                 (mapcan (lambda (node)
+                           (when (and (listp node) (eq (dom-tag node) tag))
+                             (list node)))
+                         (dom-children tree)))
+                (process-section
+                 (sec)
+                 `(,(dom-attr sec 'name)
+                   ,(expand-file-name (dom-attr sec 'link) base)
+                   ,(mapcar #'process-section (children-by-tag
+                                               sec 'sub)))))
+      `(,(or (dom-attr dom 'title) "Untitled")
+        ,(or (dom-attr dom 'name) (file-name-base file))
+        ,(or (dom-attr dom 'language) "any")
+        ,(expand-file-name (dom-attr dom 'link) base)
+        ,(mapcar #'process-section
+                 (mapcan (lambda (tree) (children-by-tag tree 'sub))
+                         (children-by-tag dom 'chapters)))
+        ,(mapcar
+          (lambda (kw)
+            `(,(dom-attr kw 'name)
+              ,(or (dom-attr kw 'type) "function")
+              ,(expand-file-name (dom-attr kw 'link) base)))
+          (mapcan (lambda (tree)
+                    (children-by-tag
+                     tree (if (eq version 1) 'function 'keyword)))
+                  (children-by-tag dom 'functions)))))))
+
+(defun devhelp--search-for-books ()
+  "Search for Devhelp books in `devhelp-search-directories'.
+
+Return a list of book data returned by `devhelp--parse-devhelp-file' for
+each valid Devhelp books."
+  (unless (fboundp 'libxml-parse-html-region)
+    (error "This function requires Emacs to be compiled with libxml2"))
+  (let ((books nil))
+    (dolist (path devhelp-search-directories)
+      (when (file-directory-p path)
+        (dolist (dir (directory-files path))
+          (when (and (file-directory-p (expand-file-name dir path))
+                     (not (member dir '("." ".."))))
+            (catch 'stop
+              (dolist (suffix '(".devhelp2" ".devhelp2.gz"
+                                ".devhelp" ".devhelp.gz"))
+                (let ((file (expand-file-name
+                             (concat dir suffix)
+                             (expand-file-name dir path))))
+                  (when (file-regular-p file)
+                    (ignore-errors
+                      (push (devhelp--parse-devhelp-file file) books)
+                      (throw 'stop nil))))))))))
+    (sort books (lambda (a b) (string< (car a) (car b))))))
+
+(defun devhelp--file-to-url (file)
+  "Convert path FILE to URL and return it."
+  (concat "file://" (and (memq system-type '(windows-nt ms-dos)) "/")
+          file))
+
+(defun devhelp-toc ()
+  "Open table of contents, of all books.
+
+If a single file was opened, only show that book's table of contents."
+  (interactive)
+  (when (cdr devhelp--history)
+    (if (eq (nth 1 (nth (car devhelp--history) (cdr devhelp--history)))
+            'history)
+        (setf (nthcdr (car devhelp--history) (cdr devhelp--history))
+              (nthcdr (1+ (car devhelp--history)) (cdr devhelp--history)))
+      (setf (nth 2 (nth (car devhelp--history) (cdr devhelp--history)))
+            (point))
+      (setf (cdr devhelp--history) (nthcdr (car devhelp--history)
+                                           (cdr devhelp--history)))))
+  (setf (car devhelp--history) 0)
+  (push (list nil 'toc (point-min)) (cdr devhelp--history))
+  (devhelp--toc-1)
+  (goto-char (point-min)))
+
+(defun devhelp--toc-1 ()
+  "Show table of contents.
+
+See `devhelp-toc' for more details."
+  (let ((inhibit-read-only t))
+    (erase-buffer)
+    (insert
+     "<html><head><title>Table of contents</title></head><body><ul>"
+     (let ((book-tocs
+            (mapcar
+             (lambda (book)
+               (cl-labels ((section-to-html
+                            (section)
+                            (concat
+                             "<li>"
+                             (format
+                              "<a href=%S>%s</a>"
+                              (devhelp--file-to-url (nth 1 section))
+                              (nth 0 section))
+                             (when (nth 2 section)
+                               (format
+                                "<ul>%s</ul>"
+                                (mapconcat #'section-to-html
+                                           (nth 2 section) "")))
+                             "</li>")))
+                 (cons
+                  (nth 2 book)
+                  (concat
+                   (format
+                    "<b><a href=%S>%s</a></b>"
+                    (devhelp--file-to-url (nth 3 book)) (nth 0 book))
+                   (when (nth 4 book)
+                     (format
+                      "<ul>%s</ul>"
+                      (mapconcat #'section-to-html (nth 4 book) "")))))))
+             devhelp--books)))
+       (if (not devhelp-toc-group-books-by-language)
+           (mapconcat (lambda (toc) (format "<li>%s</li>" (cdr toc)))
+                      book-tocs "")
+         (let ((groups nil))
+           (dolist (toc book-tocs)
+             (if-let ((pair (assoc (car toc) groups)))
+                 (setf (cdr pair) (nconc (cdr pair) (list (cdr toc))))
+               (push (cons (car toc) (list (cdr toc))) groups)))
+           (setq groups (sort groups (lambda (a b)
+                                       (string< (car a) (car b)))))
+           (mapconcat
+            (lambda (group)
+              (when (cdr group)
+                (format
+                 "<li><b><u>Language: %s</u></b><ul>%s</ul></li>"
+                 (capitalize (car group))
+                 (mapconcat (lambda (toc) (format "<li>%s</li>" toc))
+                            (cdr group) ""))))
+            groups ""))))
+     "</ul></body></html>")
+    (devhelp--render-html)
+    (goto-char (point-min))))
+
+(defun devhelp-index ()
+  "Show index, of all books.
+
+If a single file was opened, only show that book's index."
+  (interactive)
+  (when (cdr devhelp--history)
+    (if (eq (nth 1 (nth (car devhelp--history) (cdr devhelp--history)))
+            'history)
+        (setf (nthcdr (car devhelp--history) (cdr devhelp--history))
+              (nthcdr (1+ (car devhelp--history)) (cdr devhelp--history)))
+      (setf (nth 2 (nth (car devhelp--history) (cdr devhelp--history)))
+            (point))
+      (setf (cdr devhelp--history) (nthcdr (car devhelp--history)
+                                           (cdr devhelp--history)))))
+  (setf (car devhelp--history) 0)
+  (push (list nil 'index (point-min)) (cdr devhelp--history))
+  (devhelp--index-1)
+  (goto-char (point-min)))
+
+(defun devhelp--index-1 ()
+  "Show table of contents.
+
+See `devhelp-index' for more details."
+  (let ((inhibit-read-only t))
+    (erase-buffer)
+    (insert
+     "<html><head><title>Index</title></head><body><ul>"
+     (let ((keywords (mapcan (lambda (book)
+                            (copy-sequence (nth 5 book)))
+                          devhelp--books)))
+       (sort keywords (lambda (a b) (string< (car a) (car b))))
+       (if (not devhelp-index-group-keywords-by-type)
+           (mapconcat (lambda (keyword)
+                        (format "<li>%s <a href=%S>%s</a></li>"
+                                (capitalize (nth 1 keyword))
+                                (devhelp--file-to-url (nth 2 keyword))
+                                (nth 0 keyword)))
+                      keywords "")
+         (let ((groups nil))
+           (dolist (keyword keywords)
+             (let ((entry (format "<a href=%S>%s</a>"
+                                  (devhelp--file-to-url (nth 2 keyword))
+                                  (nth 0 keyword))))
+               (if-let ((pair (assoc (nth 1 keyword) groups)))
+                   (setf (cdr pair) (nconc (cdr pair) (list entry)))
+                 (push (cons (nth 1 keyword) (list entry)) groups))))
+           (setq groups (sort groups (lambda (a b)
+                                       (string< (car a) (car b)))))
+           (mapconcat
+            (lambda (group)
+              (when (cdr group)
+                (format
+                 "<li><b><u>Type: %s</u></b><ul>%s</ul></li>"
+                 (capitalize (car group))
+                 (mapconcat (lambda (entry) (format "<li>%s</li>" entry))
+                            (cdr group) ""))))
+            groups ""))))
+     "</ul></body></html>")
+    (devhelp--render-html)
+    (goto-char (point-min))))
+
+(defun devhelp--set-title (title)
+  "Set the title of current page to TITLE."
+  (setq header-line-format
+        (when title (replace-regexp-in-string "%" "%%" title)))
+  (setf (car (nth (car devhelp--history) (cdr devhelp--history))) title))
+
+(defun devhelp-browse-url (&optional event)
+  "Follow link under point/mouse.
+
+EVENT is a mouse event, if any."
+  (interactive (list last-nonmenu-event))
+  (mouse-set-point event)
+  (let ((link (get-text-property (point) 'shr-url)))
+    (devhelp--browse-url-1 link)))
+
+(defun devhelp--browse-url-1 (link)
+  "Goto url specified in LINK."
+  (if (not (stringp link))
+      (user-error "No link under point")
+    (if-let ((url (url-generic-parse-url link))
+             ((string= (url-type url) "file"))
+             (file (url-filename url)))
+        (progn
+          (when (cdr devhelp--history)
+            (setf (nth 2 (nth (car devhelp--history)
+                              (cdr devhelp--history)))
+                  (point))
+            (setf (cdr devhelp--history)
+                  (nthcdr (car devhelp--history)
+                          (cdr devhelp--history))))
+          (setf (car devhelp--history) 0)
+          (push (list nil (url-recreate-url (url-parse-make-urlobj
+                                             nil nil nil nil nil file
+                                             (url-target url)))
+                      (point-min))
+                (cdr devhelp--history))
+          (devhelp--set-title "Untitled")
+          (devhelp--render-html-file
+           (if (memq system-type '(windows-nt ms-dos))
+               (substring file 1)
+             file))
+          (goto-char (point-min))
+          (when (and (url-target url)
+                     (not (string-empty-p (url-target url))))
+            (text-property-search-forward 'shr-target-id (url-target url)))
+          (recenter 0)
+          (setf (nth 2 (nth 0 (cdr devhelp--history))) (point)))
+      (browse-url url))))
+
+(defun devhelp--render-html (&optional base)
+  "Render HTML in current buffer.
+
+When BASE is given, use it to make relative URLs absolute."
+  (let ((shr-map
+         (let ((map (make-sparse-keymap)))
+           (set-keymap-parent map shr-map)
+           (let ((fn (if (eq (nth 1 (nth (car devhelp--history)
+                                         (cdr devhelp--history)))
+                             'history)
+                         #'devhelp-history-goto #'devhelp-browse-url)))
+             (define-key map (kbd "RET") fn)
+             (define-key map [mouse-2] fn))
+           map))
+        (shr-external-rendering-functions
+         (append `((title
+                    . ,(lambda (dom)
+                         (devhelp--set-title (car (dom-children dom))))))
+                 shr-external-rendering-functions))
+        (shr-use-fonts devhelp-use-variable-pitch-font)
+        (shr-width devhelp-text-width)
+        (dom (libxml-parse-html-region (point-min) (point-max))))
+    (erase-buffer)
+    (shr-insert-document (if base `(base ((href . ,base)) (,dom)) dom))
+    (goto-char (point-min))))
+
+(defun devhelp--render-html-file (file)
+  "Load and render HTML file FILE in current buffer."
+  (let ((inhibit-read-only t))
+    (erase-buffer)
+    (insert-file-contents file)
+    (devhelp--render-html (devhelp--file-to-url file))))
+
+(defun devhelp--history-goto (n)
+  "Goto Nth page in `devhelp--history'."
+  (if (not (< -1 n (if (eq (nth 1 (nth (car devhelp--history)
+                                       (cdr devhelp--history)))
+                           'history)
+                       (1- (length (cdr devhelp--history)))
+                     (length (cdr devhelp--history)))))
+      (user-error (concat (if (< n 0) "Beginning" "End") " of history"))
+    (when (eq (nth 1 (nth (car devhelp--history) (cdr devhelp--history)))
+              'history)
+      (setf (nthcdr (car devhelp--history) (cdr devhelp--history))
+            (nthcdr (1+ (car devhelp--history)) (cdr devhelp--history))))
+    (setf (nth 2 (nth (car devhelp--history)
+                      (cdr devhelp--history)))
+          (point))
+    (setf (car devhelp--history) n)
+    (if (symbolp (nth 1 (nth n (cdr devhelp--history))))
+        (pcase (nth 1 (nth n (cdr devhelp--history)))
+          ('toc (devhelp--toc-1))
+          ('index (devhelp--index-1)))
+      (let* ((url (url-generic-parse-url
+                   (devhelp--file-to-url
+                    (nth 1 (nth n (cdr devhelp--history))))))
+             (file (url-filename url)))
+        (devhelp--render-html-file
+         (if (memq system-type '(windows-nt ms-dos))
+             (substring file 1)
+           file))))
+    (goto-char (nth 2 (nth n (cdr devhelp--history))))
+    (recenter)))
+
+(defun devhelp-history-back (&optional n)
+  "Go to the previous page.
+
+When prefix argument N is given, go to Nth previous page."
+  (interactive "p")
+  (devhelp--history-goto (+ (car devhelp--history) n)))
+
+(defun devhelp-history-forward (&optional n)
+  "Go to the next page.
+
+When prefix argument N is given, go to Nth next page."
+  (interactive "p")
+  (devhelp--history-goto (- (car devhelp--history) n)))
+
+(defun devhelp-history-goto (&optional event)
+  "Go to history link under point.
+
+This only works in history page.
+
+EVENT is a mouse event, if any."
+  (interactive (list last-nonmenu-event))
+  (mouse-set-point event)
+  (unless (eq (nth 1 (nth (car devhelp--history)
+                          (cdr devhelp--history)))
+              'history)
+    (user-error "Not in history page"))
+  (devhelp--history-goto
+   (string-to-number (get-text-property (point) 'shr-url))))
+
+(defun devhelp-history ()
+  "Show history."
+  (interactive)
+  (setf (nth 2 (nth (car devhelp--history) (cdr devhelp--history)))
+        (point))
+  (let ((inhibit-read-only t))
+    (erase-buffer)
+    (insert "<html><head><title>History of visited pages</title></head>"
+            "<body><h1>History of visited pages</h1><ul>")
+    (dolist (i (number-sequence 0 (1- (length (cdr devhelp--history)))))
+      (insert (format "<li><a href=\"%i\">%s</a></li>" i
+                      (let ((title (car (nth i (cdr devhelp--history)))))
+                        (if (eq i (car devhelp--history))
+                            (format "<i>%s</i>" title)
+                          title)))))
+    (insert "</ul></body></html>")
+    (push (list nil 'history (point-min)) (nthcdr (car devhelp--history)
+                                                  (cdr devhelp--history)))
+    (devhelp--render-html)))
+
+(defun devhelp--directory ()
+  "List all available Devhelp books."
+  (message "Composing Devhelp directory...")
+  (setq devhelp--books (devhelp--search-for-books))
+  (devhelp-toc)
+  (message "Composing Devhelp directory...done"))
+
+(defun devhelp--open-file (file)
+  "Open FILE in current buffer."
+  (setq devhelp--books (list (devhelp--parse-devhelp-file file)))
+  (devhelp--browse-url-1 (devhelp--file-to-url
+                          (nth 3 (car devhelp--books)))))
+
+;;;###autoload
+(defun devhelp (file buffer)
+  "Browse documentation in Devhelp format.
+
+Interactively, when a non-numeric prefix argument is given, the Devhelp
+file name is read interactively from the minibuffer.  When a numeric
+argument N is given, a buffer named \"*devhelp*<N>\" is selected.
+
+Optional argument BUFFER specifies the BUFFER to use, it can be a live
+buffer or a buffer name.  If BUFFER is a buffer name and the buffer doesn't
+exist, it is created.
+
+Optional argument FILE specifies the file to open, the default is to open
+the conbined table of contents of all available Devhelp books."
+  (interactive
+   (list (when (and current-prefix-arg (not (numberp current-prefix-arg)))
+           (read-file-name "Devhelp file name: " nil nil t))
+         (when (numberp current-prefix-arg)
+           (format "*devhelp*<%s>" current-prefix-arg))))
+  (unless (fboundp 'libxml-parse-html-region)
+    (error "This function requires Emacs to be compiled with libxml2"))
+  (with-current-buffer (get-buffer-create (or buffer "*devhelp*"))
+    (devhelp-mode)
+    (display-buffer (current-buffer))
+    (if (not file)
+        (devhelp--directory)
+      (devhelp--open-file file))))
+
+(defun devhelp--make-bookmark-record ()
+  "Make a bookmark record."
+  (let ((entry (nth (car devhelp--history) (cdr devhelp--history))))
+    `(,(nth 0 entry)
+      (filename . ,(when (stringp (nth 1 entry)) (nth 1 entry)))
+      (file . ,(nth 1 entry))
+      (position . ,(nth 2 entry))
+      (handler . devhelp-bookmake-jump))))
+
+;;;###autoload
+(defun devhelp-bookmake-jump (bookmark)
+  "Jump to BOOKMARK."
+  (unless (fboundp 'libxml-parse-html-region)
+    (error "This function requires Emacs to be compiled with libxml2"))
+  (with-current-buffer (generate-new-buffer "*devhelp*")
+    (devhelp-mode)
+    (display-buffer (current-buffer))
+    (setq devhelp--books (devhelp--search-for-books))
+    (setq devhelp--history
+          `(0 . ((nil ,(bookmark-prop-get bookmark 'file)
+                      ,(bookmark-prop-get bookmark 'position)))))
+    (if (symbolp (bookmark-prop-get bookmark 'file))
+        (pcase (bookmark-prop-get bookmark 'file)
+          ('toc (devhelp--toc-1))
+          ('index (devhelp--index-1)))
+      (let ((file (url-filename
+                   (url-generic-parse-url
+                    (devhelp--file-to-url
+                     (bookmark-prop-get bookmark 'file))))))
+        (devhelp--set-title "Untitled")
+        (devhelp--render-html-file
+         (if (memq system-type '(windows-nt ms-dos))
+             (substring file 1)
+           file))
+        (goto-char (min (max (bookmark-prop-get bookmark 'position)
+                             (point-min))
+                        (point-max)))
+        (recenter 0)
+        (setf (nth 2 (nth 0 (cdr devhelp--history))) (point))))))
+
+(defvar devhelp-mode-map
+  (let ((map (make-sparse-keymap)))
+    (define-key map (kbd "i") #'devhelp-index)
+    (define-key map (kbd "d") #'devhelp-toc)
+    (define-key map (kbd "l") #'devhelp-history-back)
+    (define-key map (kbd "r") #'devhelp-history-forward)
+    (define-key map (kbd "L") #'devhelp-history)
+    map)
+  "Keymap for Devhelp mode.")
+
+(define-derived-mode devhelp-mode special-mode "Devhelp"
+  "Major mode for browsing Devhelp books."
+  (setq-local devhelp--books nil)
+  (setq-local devhelp--history '(nil . nil))
+  (setq-local bookmark-make-record-function
+              #'devhelp--make-bookmark-record))
+
+(provide 'devhelp)
+;;; devhelp.el ends here



reply via email to

[Prev in Thread] Current Thread [Next in Thread]