Questions tagged [documentation]
65 questions
11
votes
4 answers
How to make M-x and C-h f share the history?
It's quite common that I'll look through a command's documentation
with C-h f, and then invoke the command with M-x immediately
afterwards.
Right now, the shortest way I've found to “invoke the last view
command” is to copy its name (either from the…
Malabarba
- 22,878
- 6
- 78
- 163
11
votes
2 answers
Jump to documentation buffer with company-mode
I have recently switched from auto-complete-mode to company-mode and I having fun. Recently I had to write some Emacs Lisp code. I start typing my function, completion candidates are shown, I press F1 and the documentation opens up in another…
petrux
- 665
- 1
- 5
- 18
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,608
- 1
- 20
- 51
10
votes
1 answer
In Org Mode, how do I link to internal documentation?
I want to create a clickable-link in my Org file directly to documentation built into Emacs. Is this possible to do? The documentation I want to link to are:
Emacs Lisp Intro
The GNU Emacs Lisp Reference Manual
TheOddsFavourUs
- 189
- 8
10
votes
2 answers
How to display overlay like this screencast?
How to make an overlay in Emacs like the following (maybe it's not overlay, I don't know, it's from company-coq inline-docs):
stardiviner
- 1,888
- 26
- 45
10
votes
1 answer
Meaning of CRM column in buffer list from `C-x C-b`?
In the Buffer List, I wonder what the CRM column means and ., *, % and D mean in the column? For example
CRM Buffer Size Mode File
. * .emacs 3294 Emacs-Lisp ~/.emacs
% *Help* …
Tim
- 4,987
- 7
- 31
- 60
8
votes
1 answer
How to discover (standard) function names?
When programing emacs (or common) lisp, how to discover (standard) function names (using emacs and working offline)?
Example: Let's say you want to shift bits of an integer, but you don't now the name of the function, which can do this…
jue
- 4,476
- 8
- 20
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,848
- 16
- 27
7
votes
2 answers
How to view package Full Description (commentary section) inside Emacs
I'm looking for a way to visualize inside Emacs the Full Description of a
package as shown in Elpa index page.
For example the undo-tree package has a nice and comprehensive help
page/description embedded in its source code which is fully shown in…
Alexandro de Oliveira
- 767
- 1
- 6
- 17
6
votes
2 answers
Get help for a package
Is there a way to get a quick help for a certain package? Something similar you get when you click package description in Paradox. I think it would be interesting a sort of doc package which get the list of your installed packages and fetch the…
Enrico Pirani
- 367
- 2
- 10
6
votes
1 answer
hierarchy of modes
I am aware that org-mode derives from outline-mode, in the same way as outline-mode derives from text-mode, which derives from nil.
I have always wonder if there exists something similar to a documented tree of major modes allowing to follow hooks,…
csantosb
- 1,045
- 6
- 15
5
votes
1 answer
How to look up documentation for a minor mode?
I just decided that I should try the outline-minor-mode for showing and hiding Emacs lisp defun definitions in an Emacs Lisp file. So I typed M-x outline-minor-mode and then I would like to get an overview over the available keyboard shortcuts, so I…
Håkon Hægland
- 3,608
- 1
- 20
- 51
5
votes
4 answers
Info file emacs does not exist
When I type C-h r I get error:
Debugger entered--Lisp error: (error "Info file emacs does not exist")
signal(error ("Info file emacs does not exist")) error("Info file %s
does not exist" "emacs") Info-find-file("emacs")
…
Håkon Hægland
- 3,608
- 1
- 20
- 51
5
votes
1 answer
Where is the python.el documentation?
I am using emacs-24.3, which comes with python.el and IPython support out of the box (or so they say).
Is there documentation for this mode? Where can I find it?
dmvianna
- 370
- 4
- 21
5
votes
1 answer
Are the graphical depictions in docs drawed in manual labour?
There are tons of pretty graphical depictions in the emacs(or elisp) docs such as
x1:
-------------- -------------- --------------
| car | cdr | | car | cdr | | car | cdr |
| a | o------->| b | …
AbstProcDo
- 1,231
- 5
- 15