Emacs Stack Exchange
Emacs Stack Exchange

Questions tagged [documentation]

68 questions
10
votes
1 answer

How to quote symbols in a documentation string?

In the Emacs Lisp documentation, I often come across quoted symbols like `buffer-file-name' inside docstrings. The intersting thing here is the style of quoting, by surrounding the symbol name with a backtick and a quote. I was curious where this…
Håkon Hægland
  • 3,648
  • 1
  • 22
  • 51
8
votes
1 answer

Good ways to access documentation?

Emacs has self-documentation as one of its goals, and it achieves this pretty well for Emacs Lisp with commands like describe-variable, describe-function, etc. Packages like company-quickhelp make this even more convenient by providing help in…
Tianxiang Xiong
  • 3,878
  • 18
  • 28
3
votes
2 answers

how often is the official Emacs manual updated?

Q: How often/quickly is the official Emacs manual updated? The release announcement of Emacs 24.4 has a blurb at the bottom stating that the FSF's official Emacs manual has been updated to correspond to version 24.2. It also notes that buying the…
Dan
  • 32,980
  • 7
  • 102
  • 169
2
votes
1 answer

Why Emacs using `dumping` during building?

I'm not a C programmer and I am reading the GNU Emacs Lisp manual. Something grabs my attention in E.1 Building Emacs is Emacs use dumping to get a executable program other than temacs. I am wondering why Emacs choose to do this. After searching…
cmal
  • 775
  • 3
  • 14
1
vote
0 answers

How to start contributing to emacs manual

Actually I am thinking to contribute to emacs manual, Specially in eshell few sections are empty so. Just need some guidance/resource to refer to write in texinfo
nerding_it
  • 181
  • 6
1
vote
1 answer

Doxygen support

I'm creating some doxygen in Emacs and I can't find any mode for this purpose. The only mode I found is the below project which seems too old (last release from 2007!). Do you any alternatives to this mode? http://doxymacs.sourceforge.net/ Emacs…
rkachach
  • 111
  • 4
1
vote
0 answers

How to cross reference input method in docstring?

I'd like to cross reference an input method from a minor mode docstring: (define-derived-mode xxx ... "Super `xxx' derived mode. Cool to use with input method `my-magic-input-method'.") Now my-magic-input-method is not linked in *Help*…
Gracjan Polak
  • 1,102
  • 6
  • 21
0
votes
1 answer

Function that updates function documentation

Could the following command be put in a function that takes a function name (workbench) and a variable (workbench-usage) containing the usage string. (put 'workbench 'function-documentation (concat (documentation 'workbench t)…
Dilna
  • 1
  • 3
  • 11
0
votes
0 answers

Autogenerate HTML files out emacs help

Am I right to say that the content I read when doing C-h f foobar (or something like that) is read directly from the lisp sources? In Python I would call it docstrings. In Python I can use Sphinx, doxygen, etc. to create HTML (or other formats) out…
buhtz
  • 729
  • 5
  • 23
0
votes
1 answer

emacs' internal documentation missing info?

Emacs 26.1 on Debian 10 stable I have previously used the Windows version of Emacs and now I'm back in Linux (thanks to it). When pressing C-h i d there seemed to be a lot of more information in the Windows version. Now I can only see Org-mode,…
Sergiu Elmi
  • 187
  • 10
0
votes
1 answer

How to install `*-utils` manuals in GNU Emacs on Mac OS X?

I've been using GNU manuals of core-utils and find-utils and so on in GNU Emacs when I am using GNU Linux. They are default after installing GNU Emacs on many GNU Linux distributions. After open GNU Emacs and C-h i I'll find the core-utils and…
cmal
  • 775
  • 3
  • 14