Merge branch 'add-more-command-names'

This commit is contained in:
Carsten Dominik 2010-11-05 06:53:20 +01:00
commit 4d0252b8ac
1 changed files with 46 additions and 90 deletions

View File

@ -53,6 +53,11 @@
@item @kbd{\key\} @item @kbd{\key\}
@end macro @end macro
@macro xorgkey{key}
@kindex \key\
@itemx @kbd{\key\}
@end macro
@c one key with a command @c one key with a command
@c Inserts: @item KEY COMMAND @c Inserts: @item KEY COMMAND
@macro orgcmd{key,command} @macro orgcmd{key,command}
@ -9332,8 +9337,7 @@ In particular, note that you can place commonly-used (export) options in
a separate file which can be included using @code{#+SETUPFILE}. a separate file which can be included using @code{#+SETUPFILE}.
@table @kbd @table @kbd
@kindex C-c C-e t @orgcmd{C-c C-e t,org-insert-export-options-template}
@item C-c C-e t
Insert template with export options, see example below. Insert template with export options, see example below.
@end table @end table
@ -9445,8 +9449,7 @@ contains one outline tree, the first heading is used as document title and
the subtrees are exported. the subtrees are exported.
@table @kbd @table @kbd
@kindex C-c C-e @orgcmd{C-c C-e,org-export}
@item C-c C-e
@vindex org-export-run-in-background @vindex org-export-run-in-background
Dispatcher for export and publishing commands. Displays a help-window Dispatcher for export and publishing commands. Displays a help-window
listing the additional key(s) needed to launch an export or publishing listing the additional key(s) needed to launch an export or publishing
@ -9454,12 +9457,10 @@ command. The prefix arg is passed through to the exporter. A double prefix
@kbd{C-u C-u} causes most commands to be executed in the background, in a @kbd{C-u C-u} causes most commands to be executed in the background, in a
separate Emacs process@footnote{To make this behavior the default, customize separate Emacs process@footnote{To make this behavior the default, customize
the variable @code{org-export-run-in-background}.}. the variable @code{org-export-run-in-background}.}.
@kindex C-c C-e v @orgcmd{C-c C-e v,org-export-visible}
@item C-c C-e v
Like @kbd{C-c C-e}, but only export the text that is currently visible Like @kbd{C-c C-e}, but only export the text that is currently visible
(i.e. not hidden by outline visibility). (i.e. not hidden by outline visibility).
@kindex C-u C-u C-c C-e @orgcmd{C-u C-u C-c C-e,org-export}
@item C-u C-u C-c C-e
@vindex org-export-run-in-background @vindex org-export-run-in-background
Call an the exporter, but reverse the setting of Call an the exporter, but reverse the setting of
@code{org-export-run-in-background}, i.e. request background processing if @code{org-export-run-in-background}, i.e. request background processing if
@ -9480,8 +9481,7 @@ with special characters and symbols available in these encodings.
@cindex active region @cindex active region
@cindex transient-mark-mode @cindex transient-mark-mode
@table @kbd @table @kbd
@kindex C-c C-e a @orgcmd{C-c C-e a,org-export-as-ascii}
@item C-c C-e a
@cindex property, EXPORT_FILE_NAME @cindex property, EXPORT_FILE_NAME
Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file Export as ASCII file. For an Org file, @file{myfile.org}, the ASCII file
will be @file{myfile.txt}. The file will be overwritten without will be @file{myfile.txt}. The file will be overwritten without
@ -9492,21 +9492,15 @@ current subtree, use @kbd{C-c @@}.}, the tree head will
become the document title. If the tree head entry has or inherits an become the document title. If the tree head entry has or inherits an
@code{EXPORT_FILE_NAME} property, that name will be used for the @code{EXPORT_FILE_NAME} property, that name will be used for the
export. export.
@kindex C-c C-e A @orgcmd{C-c C-e A,org-export-as-ascii-to-buffer}
@item C-c C-e A
Export to a temporary buffer, do not create a file. Export to a temporary buffer, do not create a file.
@kindex C-c C-e n @orgcmd{C-c C-e n,org-export-as-latin1}
@kindex C-c C-e N @xorgcmd{C-c C-e N,org-export-as-latin1-to-buffer}
@item C-c C-e n @ @ @r{and} @ @ C-c C-e N
Like the above commands, but use Latin-1 encoding. Like the above commands, but use Latin-1 encoding.
@kindex C-c C-e u @orgcmd{C-c C-e u,org-export-as-utf8}
@kindex C-c C-e U @xorgcmd{C-c C-e U,org-export-as-utf8-to-buffer}
@item C-c C-e u @ @ @r{and} @ @ C-c C-e U
Like the above commands, but use UTF-8 encoding. Like the above commands, but use UTF-8 encoding.
@kindex C-c C-e v a @item C-c C-e v a/n/u
@kindex C-c C-e v n
@kindex C-c C-e v u
@item C-c C-e v a @ @ @r{and} @ @ C-c C-e v n @ @ @r{and} @ @ C-c C-e v u
Export only the visible part of the document. Export only the visible part of the document.
@end table @end table
@ -9561,8 +9555,7 @@ language, but with additional support for tables.
@cindex active region @cindex active region
@cindex transient-mark-mode @cindex transient-mark-mode
@table @kbd @table @kbd
@kindex C-c C-e h @orgcmd{C-c C-e h,org-export-as-html}
@item C-c C-e h
@cindex property, EXPORT_FILE_NAME @cindex property, EXPORT_FILE_NAME
Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org}, Export as HTML file @file{myfile.html}. For an Org file @file{myfile.org},
the ASCII file will be @file{myfile.html}. The file will be overwritten the ASCII file will be @file{myfile.html}. The file will be overwritten
@ -9572,25 +9565,15 @@ exported. If the selected region is a single tree@footnote{To select the
current subtree, use @kbd{C-c @@}.}, the tree head will become the document current subtree, use @kbd{C-c @@}.}, the tree head will become the document
title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
property, that name will be used for the export. property, that name will be used for the export.
@kindex C-c C-e b @orgcmd{C-c C-e b,org-export-as-html-and-open}
@item C-c C-e b
Export as HTML file and immediately open it with a browser. Export as HTML file and immediately open it with a browser.
@kindex C-c C-e H @orgcmd{C-c C-e H,org-export-as-html-to-buffer}
@item C-c C-e H
Export to a temporary buffer, do not create a file. Export to a temporary buffer, do not create a file.
@kindex C-c C-e R @orgcmd{C-c C-e R,org-export-region-as-html}
@item C-c C-e R
Export the active region to a temporary buffer. With a prefix argument, do Export the active region to a temporary buffer. With a prefix argument, do
not produce the file header and footer, but just the plain HTML section for not produce the file header and footer, but just the plain HTML section for
the region. This is good for cut-and-paste operations. the region. This is good for cut-and-paste operations.
@kindex C-c C-e v h @item C-c C-e v h/b/H/R
@kindex C-c C-e v b
@kindex C-c C-e v H
@kindex C-c C-e v R
@item C-c C-e v h
@item C-c C-e v b
@item C-c C-e v H
@item C-c C-e v R
Export only the visible part of the document. Export only the visible part of the document.
@item M-x org-export-region-as-html @item M-x org-export-region-as-html
Convert the region to HTML under the assumption that it was Org-mode Convert the region to HTML under the assumption that it was Org-mode
@ -9952,8 +9935,7 @@ linked.
@cindex active region @cindex active region
@cindex transient-mark-mode @cindex transient-mark-mode
@table @kbd @table @kbd
@kindex C-c C-e l @orgcmd{C-c C-e l,org-export-as-latex}
@item C-c C-e l
@cindex property EXPORT_FILE_NAME @cindex property EXPORT_FILE_NAME
Export as La@TeX{} file @file{myfile.tex}. For an Org file Export as La@TeX{} file @file{myfile.tex}. For an Org file
@file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will
@ -9963,13 +9945,9 @@ exported. If the selected region is a single tree@footnote{To select the
current subtree, use @kbd{C-c @@}.}, the tree head will become the document current subtree, use @kbd{C-c @@}.}, the tree head will become the document
title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME}
property, that name will be used for the export. property, that name will be used for the export.
@kindex C-c C-e L @orgcmd{C-c C-e L,org-export-as-latex-to-buffer}
@item C-c C-e L
Export to a temporary buffer, do not create a file. Export to a temporary buffer, do not create a file.
@kindex C-c C-e v l @item C-c C-e v l/L
@kindex C-c C-e v L
@item C-c C-e v l
@item C-c C-e v L
Export only the visible part of the document. Export only the visible part of the document.
@item M-x org-export-region-as-latex @item M-x org-export-region-as-latex
Convert the region to La@TeX{} under the assumption that it was Org-mode Convert the region to La@TeX{} under the assumption that it was Org-mode
@ -9978,11 +9956,9 @@ buffer.
@item M-x org-replace-region-by-latex @item M-x org-replace-region-by-latex
Replace the active region (assumed to be in Org-mode syntax) by La@TeX{} Replace the active region (assumed to be in Org-mode syntax) by La@TeX{}
code. code.
@kindex C-c C-e p @orgcmd{C-c C-e p,org-export-as-pdf}
@item C-c C-e p
Export as La@TeX{} and then process to PDF. Export as La@TeX{} and then process to PDF.
@kindex C-c C-e d @orgcmd{C-c C-e d,org-export-as-pdf-and-open}
@item C-c C-e d
Export as La@TeX{} and then process to PDF, then open the resulting PDF file. Export as La@TeX{} and then process to PDF, then open the resulting PDF file.
@end table @end table
@ -10203,8 +10179,7 @@ support with
@end example @end example
@table @kbd @table @kbd
@kindex C-c C-b @orgcmd{C-c C-b,org-beamer-select-environment}
@item C-c C-b
In @code{org-beamer-mode}, this key offers fast selection of a beamer In @code{org-beamer-mode}, this key offers fast selection of a beamer
environment or the @code{BEAMER_col} property. environment or the @code{BEAMER_col} property.
@end table @end table
@ -10282,8 +10257,7 @@ Currently DocBook exporter only supports DocBook V5.0.
@cindex active region @cindex active region
@cindex transient-mark-mode @cindex transient-mark-mode
@table @kbd @table @kbd
@kindex C-c C-e D @orgcmd{C-c C-e D,org-export-as-docbook}
@item C-c C-e D
@cindex property EXPORT_FILE_NAME @cindex property EXPORT_FILE_NAME
Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML Export as DocBook file. For an Org file, @file{myfile.org}, the DocBook XML
file will be @file{myfile.xml}. The file will be overwritten without file will be @file{myfile.xml}. The file will be overwritten without
@ -10293,8 +10267,7 @@ exported. If the selected region is a single tree@footnote{To select the
current subtree, use @kbd{C-c @@}.}, the tree head will become the document current subtree, use @kbd{C-c @@}.}, the tree head will become the document
title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME} title. If the tree head entry has, or inherits, an @code{EXPORT_FILE_NAME}
property, that name will be used for the export. property, that name will be used for the export.
@kindex C-c C-e V @orgcmd{C-c C-e V,org-export-as-docbook-pdf-and-open}
@item C-c C-e V
Export as DocBook file, process to PDF, then open the resulting PDF file. Export as DocBook file, process to PDF, then open the resulting PDF file.
@vindex org-export-docbook-xslt-proc-command @vindex org-export-docbook-xslt-proc-command
@ -10311,8 +10284,7 @@ variable @code{org-export-docbook-xslt-stylesheet}, which needs to be set by
the user. You can also overrule this global setting on a per-file basis by the user. You can also overrule this global setting on a per-file basis by
adding an in-buffer setting @code{#+XSLT:} to the Org file. adding an in-buffer setting @code{#+XSLT:} to the Org file.
@kindex C-c C-e v D @orgkey{C-c C-e v D}
@item C-c C-e v D
Export only the visible part of the document. Export only the visible part of the document.
@end table @end table
@ -10476,12 +10448,10 @@ all the nodes.
@subsection TaskJuggler export commands @subsection TaskJuggler export commands
@table @kbd @table @kbd
@kindex C-c C-e j @orgcmd{C-c C-e j,org-export-as-taskjuggler}
@item C-c C-e j
Export as TaskJuggler file. Export as TaskJuggler file.
@kindex C-c C-e J @orgcmd{C-c C-e J,org-export-as-taskjuggler-and-open}
@item C-c C-e J
Export as TaskJuggler file and then open the file with TaskJugglerUI. Export as TaskJuggler file and then open the file with TaskJugglerUI.
@end table @end table
@ -10591,8 +10561,7 @@ For more information and examples see the Org-taskjuggler tutorial at
The Freemind exporter was written by Lennart Borgman. The Freemind exporter was written by Lennart Borgman.
@table @kbd @table @kbd
@kindex C-c C-e m @orgcmd{C-c C-e m,org-export-as-freemind}
@item C-c C-e m
Export as Freemind mind map @file{myfile.mm}. Export as Freemind mind map @file{myfile.mm}.
@end table @end table
@ -10605,11 +10574,9 @@ Currently, this exporter only handles the general outline structure and
does not interpret any additional Org-mode features. does not interpret any additional Org-mode features.
@table @kbd @table @kbd
@kindex C-c C-e x @orgcmd{C-c C-e x,org-export-as-xoxo}
@item C-c C-e x
Export as XOXO file @file{myfile.html}. Export as XOXO file @file{myfile.html}.
@kindex C-c C-e v @orgkey{C-c C-e v x}
@item C-c C-e v x
Export only the visible part of the document. Export only the visible part of the document.
@end table @end table
@ -10652,18 +10619,15 @@ In this way the UID remains unique, but a synchronization program can still
figure out from which entry all the different instances originate. figure out from which entry all the different instances originate.
@table @kbd @table @kbd
@kindex C-c C-e i @orgcmd{C-c C-e i,org-export-icalendar-this-file}
@item C-c C-e i
Create iCalendar entries for the current file and store them in the same Create iCalendar entries for the current file and store them in the same
directory, using a file extension @file{.ics}. directory, using a file extension @file{.ics}.
@kindex C-c C-e I @orgcmd{C-c C-e I, org-export-icalendar-all-agenda-files}
@item C-c C-e I
@vindex org-agenda-files @vindex org-agenda-files
Like @kbd{C-c C-e i}, but do this for all files in Like @kbd{C-c C-e i}, but do this for all files in
@code{org-agenda-files}. For each of these files, a separate iCalendar @code{org-agenda-files}. For each of these files, a separate iCalendar
file will be written. file will be written.
@kindex C-c C-e c @orgcmd{C-c C-e c,org-export-icalendar-combine-agenda-files}
@item C-c C-e c
@vindex org-combined-agenda-icalendar-file @vindex org-combined-agenda-icalendar-file
Create a single large iCalendar file from all files in Create a single large iCalendar file from all files in
@code{org-agenda-files} and write it to the file given by @code{org-agenda-files} and write it to the file given by
@ -11175,17 +11139,13 @@ right place on the web server, and publishing images to it.
Once properly configured, Org can publish with the following commands: Once properly configured, Org can publish with the following commands:
@table @kbd @table @kbd
@kindex C-c C-e C @orgcmd{C-c C-e X,org-publish}
@item C-c C-e C
Prompt for a specific project and publish all files that belong to it. Prompt for a specific project and publish all files that belong to it.
@kindex C-c C-e P @orgcmd{C-c C-e P,org-publish-current-project}
@item C-c C-e P
Publish the project containing the current file. Publish the project containing the current file.
@kindex C-c C-e F @orgcmd{C-c C-e F,org-publish-current-file}
@item C-c C-e F
Publish only the current file. Publish only the current file.
@kindex C-c C-e E @orgcmd{C-c C-e E,org-publish-all}
@item C-c C-e E
Publish every project. Publish every project.
@end table @end table
@ -13348,12 +13308,10 @@ these tables directly in the buffer. Instead, you need to use the command
@kbd{C-c '} to edit them, similar to source code snippets. @kbd{C-c '} to edit them, similar to source code snippets.
@table @kbd @table @kbd
@kindex C-c ' @orgcmd{C-c ',org-edit-special}
@item C-c '
Edit a @file{table.el} table. Works when the cursor is in a table.el table. Edit a @file{table.el} table. Works when the cursor is in a table.el table.
@c @c
@kindex C-c ~ @orgcmd{C-c ~,org-table-create-with-table.el}
@item C-c ~
Insert a @file{table.el} table. If there is already a table at point, this Insert a @file{table.el} table. If there is already a table at point, this
command converts it between the @file{table.el} format and the Org-mode command converts it between the @file{table.el} format and the Org-mode
format. See the documentation string of the command format. See the documentation string of the command
@ -13991,11 +13949,9 @@ the content of the block.
Dynamic blocks are updated with the following commands Dynamic blocks are updated with the following commands
@table @kbd @table @kbd
@kindex C-c C-x C-u @orgcmd{C-c C-x C-u,org-dblock-update}
@item C-c C-x C-u
Update dynamic block at point. Update dynamic block at point.
@kindex C-u C-c C-x C-u @orgkey{C-u C-c C-x C-u}
@item C-u C-c C-x C-u
Update all dynamic blocks in the current file. Update all dynamic blocks in the current file.
@end table @end table