{"id":21603145,"url":"https://github.com/evmar/devhelp-index","last_synced_at":"2025-04-11T02:36:05.105Z","repository":{"id":66490097,"uuid":"2477307","full_name":"evmar/devhelp-index","owner":"evmar","description":"command line (emacs) interface into devhelp","archived":false,"fork":false,"pushed_at":"2012-05-04T17:34:00.000Z","size":100,"stargazers_count":6,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T00:11:13.678Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/evmar.png","metadata":{"files":{"readme":"README.markdown","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-09-28T19:25:23.000Z","updated_at":"2023-09-08T16:30:41.000Z","dependencies_parsed_at":"2023-02-20T05:15:42.641Z","dependency_job_id":null,"html_url":"https://github.com/evmar/devhelp-index","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evmar%2Fdevhelp-index","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evmar%2Fdevhelp-index/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evmar%2Fdevhelp-index/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/evmar%2Fdevhelp-index/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/evmar","download_url":"https://codeload.github.com/evmar/devhelp-index/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248330189,"owners_count":21085664,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T19:15:27.195Z","updated_at":"2025-04-11T02:36:05.082Z","avatar_url":"https://github.com/evmar.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Some useful API documentation is not available as man pages but in\nsome other format:\n\n* GTK stack, including related libraries like Cairo, uses gtk-doc;\n* the excellent C++ reference available at [cppreference.com][] is HTML.\n\nIf they were man pages they'd integrate well into emacs (where `M-x\nman` shows the man page of the word under the cursor).  But both are\navailable [Devhelp][] data files, which are for a Windows\nhelp\u0026ndash;like system.  Devhelp's GUI provides lists of functions,\nkeywords, etc.\n\nThe Python scripts in this repository index the Devhelp data file to\ngenerate a plain text file mapping keywords to docs.  The elisp\ncode then provides a `M-x devhelp` command which behaves like `man`,\nexcept that it opens the result in a browser.\n\n\n[cppreference.com]: http://cppreference.com\n[gtk-doc]: http://www.gtk.org/gtk-doc/\n[Devhelp]: http://en.wikipedia.org/wiki/Devhelp\n\n## Setup\n\nFor gtk-doc based packages like Cairo, `apt-get install libcairo2-doc`.\nFor the C++ reference, install from the [PPA][].\n\nNow run `./devhelp-index.py`.  It will crawl those documentation\ndirectories and create an index in `~/.cache`.\n\nFinally, symlink `devhelp-query.py` into your PATH somewhere.  You can\nnow call it:\n\n    $ devhelp-query equal_range\n    /usr/share/cppreference/doc/en/html/en.cppreference.com/w/cpp/algorithm/equal_rangehtml.html\n\nIn Emacs, install `devhelp.el` and call it via `M-x devhelp`.  (If you\ninstall the appropriate Emacs packages, `(setq\nbrowse-url-browser-function 'w3m-browse-url)` will make Emacs use the\nw3m browser within an Emacs buffer, bringing back the `man`\nexperience.)\n\n[PPA]: https://launchpad.net/~p12/+archive/ppa\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevmar%2Fdevhelp-index","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fevmar%2Fdevhelp-index","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fevmar%2Fdevhelp-index/lists"}