| blob | 309f4f6d135bb939ef852f1db99d4fb16d844a83 |
1 ;;;### (autoloads (org-export-icalendar-combine-agenda-files org-export-icalendar-all-agenda-files
2 ;;;;;; org-export-icalendar-this-file org-diary org-agenda-list-stuck-projects
3 ;;;;;; org-tags-view org-todo-list org-agenda-list org-cycle-agenda-files
4 ;;;;;; org-batch-store-agenda-views org-store-agenda-views org-batch-agenda-csv
5 ;;;;;; org-batch-agenda org-agenda org-agenda-to-appt org-remember-handler
6 ;;;;;; org-remember org-remember-apply-template org-remember-annotation
7 ;;;;;; org-remember-insinuate org-open-at-point-global org-insert-link-global
8 ;;;;;; org-store-link orgtbl-mode turn-on-orgtbl org-run-like-in-org-mode
9 ;;;;;; turn-on-orgstruct++ turn-on-orgstruct orgstruct-mode org-global-cycle
10 ;;;;;; org-cycle org-mode) "org" "org.el" (18282 28738))
11 ;;; Generated autoloads from org.el
14 Outline-based notes management and organizer, alias
17 Org-mode develops organizational tasks around a NOTES file which
18 contains information about projects as plain text. Org-mode is
19 implemented on top of outline-mode, which is ideal to keep the content
20 of large files well structured. It supports ToDo items, deadlines and
21 time stamps, which magically appear in the diary listing of the Emacs
22 calendar. Tables are easily created with a built-in table editor.
23 Plain text URL-like links connect to websites, emails (VM), Usenet
24 messages (Gnus), BBDB entries, and any files related to the project.
25 For printing and sharing of notes, an Org-mode file (or a part of it)
26 can be exported as a structured ASCII or HTML file.
28 The following commands are available:
35 Visibility cycling for Org-mode.
37 - When this function is called with a prefix argument, rotate the entire
38 buffer through 3 states (global cycling)
39 1. OVERVIEW: Show only top-level headlines.
40 2. CONTENTS: Show all headlines of all levels, but no body text.
41 3. SHOW ALL: Show everything.
43 - When point is at the beginning of a headline, rotate the subtree started
44 by this line through 3 different states (local cycling)
45 1. FOLDED: Only the main headline is shown.
46 2. CHILDREN: The main headline and the direct children are shown.
47 From this state, you can move to one of the children
48 and zoom in further.
49 3. SUBTREE: Show the entire subtree, including body text.
51 - When there is a numeric prefix, go up to a heading with level ARG, do
52 a `show-subtree' and return to the previous cursor position. If ARG
53 is negative, go up that many levels.
55 - When point is not at the beginning of a headline, execute
56 `indent-relative', like TAB normally does. See the option
57 `org-cycle-emulate-tab' for details.
59 - Special case: if point is at the beginning of the buffer and there is
60 no headline in line 1, this function will act as if called with prefix arg.
61 But only if also the variable `org-cycle-global-at-bob' is t.
66 Cycle the global visibility. For details see `org-cycle'.
71 Toggle the minor more `orgstruct-mode'.
72 This mode is for using Org-mode structure commands in other modes.
73 The following key behave as if Org-mode was active, if the cursor
74 is on a headline, or on a plain list item (both in the definition
75 of Org-mode).
77 M-up Move entry/item up
78 M-down Move entry/item down
79 M-left Promote
80 M-right Demote
81 M-S-up Move entry/item up
82 M-S-down Move entry/item down
83 M-S-left Promote subtree
84 M-S-right Demote subtree
85 M-q Fill paragraph and items like in Org-mode
86 C-c ^ Sort entries
87 C-c - Cycle list bullet
88 TAB Cycle item visibility
89 M-RET Insert new heading/item
90 S-M-RET Insert new TODO heading / Chekbox item
91 C-c C-c Set tags / toggle checkbox
96 Unconditionally turn on `orgstruct-mode'.
101 Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
102 In addition to setting orgstruct-mode, this also exports all indentation and
103 autofilling variables from org-mode into the buffer. Note that turning
104 off orgstruct-mode will *not* remove these additonal settings.
109 Not documented
114 Unconditionally turn on `orgtbl-mode'.
119 The `org-mode' table editor as a minor mode for use in other modes.
125 This link can later be inserted into an org-buffer with
127 For some link types, a prefix arg is interpreted:
128 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
129 For file links, arg negates `org-context-in-file-links'.
134 Insert a link like Org-mode does.
135 This command can be called in any mode to insert a link in Org-mode syntax.
140 Follow a link like Org-mode does.
141 This command can be called in any mode to follow a link that has
142 Org-mode syntax.
147 Setup remember.el for use wiht Org-mode.
152 Return a link to the current location as an annotation for remember.el.
153 If you are using Org-mode files as target for data storage with
154 remember.el, then the annotations should include a link compatible with the
155 conventions in Org-mode. This function returns such a link.
160 Initialize *remember* buffer with template, invoke `org-mode'.
161 This function should be placed into `remember-mode-hook' and in fact requires
162 to be run from that hook to function properly.
167 Call `remember'. If this is already a remember buffer, re-apply template.
168 If there is an active region, make sure remember uses it as initial content
169 of the remember buffer.
171 When called interactively with a `C-u' prefix argument GOTO, don't remember
172 anything, just go to the file/headline where the selected templated usually
173 stores its notes. With a double prefix arg `C-u C-u', got to the last
174 note stored by remember.
176 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
177 associated with a template in `org-remember-tempates'.
182 Store stuff from remember.el into an org file.
183 First prompts for an org file. If the user just presses return, the value
184 of `org-default-notes-file' is used.
185 Then the command offers the headings tree of the selected file in order to
186 file the text at a specific location.
187 You can either immediately press RET to get the note appended to the
188 file, or you can use vertical cursor motion and visibility cycling (TAB) to
189 find a better place. Then press RET or <left> or <right> in insert the note.
191 Key Cursor position Note gets inserted
192 -----------------------------------------------------------------------------
193 RET buffer-start as level 1 heading at end of file
194 RET on headline as sublevel of the heading at cursor
195 RET no heading at cursor position, level taken from context.
196 Or use prefix arg to specify level manually.
197 <left> on headline as same level, before current heading
198 <right> on headline as same level, after current heading
200 So the fastest way to store the note is to press RET RET to append it to
201 the default file. This way your current train of thought is not
202 interrupted, in accordance with the principles of remember.el.
203 You can also get the fast execution without prompting by using
204 C-u C-c C-c to exit the remember buffer. See also the variable
205 `org-remember-store-without-prompt'.
207 Before being stored away, the function ensures that the text has a
209 is constructed from the current date and some additional data.
211 If the variable `org-adapt-indentation' is non-nil, the entire text is
212 also indented so that it starts in the same column as the headline
213 \(i.e. after the stars).
215 See also the variable `org-reverse-note-order'.
220 Activate appointments found in `org-agenda-files'.
221 When prefixed, prompt for a regular expression and use it as a
222 filter: only add entries if they match this regular expression.
224 FILTER can be a string. In this case, use this string as a
225 regular expression to filter results.
227 FILTER can also be an alist, with the car of each cell being
228 either 'headline or 'category. For example:
233 will only add headlines containing IMPORTANT or headlines
239 Dispatch agenda commands to collect entries to the agenda buffer.
240 Prompts for a command to execute. Any prefix arg will be passed
241 on to the selected command. The default selections are:
243 a Call `org-agenda-list' to display the agenda for current day or week.
244 t Call `org-todo-list' to display the global todo list.
245 T Call `org-todo-list' to display the global todo list, select only
246 entries with a specific TODO keyword (the user gets a prompt).
247 m Call `org-tags-view' to display headlines with tags matching
248 a condition (the user is prompted for the condition).
249 M Like `m', but select only TODO entries, no ordinary headlines.
250 L Create a timeline for the current buffer.
251 e Export views to associated files.
253 More commands can be added by configuring the variable
254 `org-agenda-custom-commands'. In particular, specific tags and TODO keyword
255 searches can be pre-defined in this way.
257 If the current buffer is in Org-mode and visiting a file, you can also
258 first press `<' once to indicate that the agenda should be temporarily
260 Pressing `<' twice means to restrict to the current subtree or region
261 \(if active).
266 Run an agenda command in batch mode and send the result to STDOUT.
267 If CMD-KEY is a string of length 1, it is used as a key in
268 `org-agenda-custom-commands' and triggers this command. If it is a
269 longer string is is used as a tags/todo match string.
270 Paramters are alternating variable names and values that will be bound
271 before running the agenda command.
276 Run an agenda command in batch mode and send the result to STDOUT.
277 If CMD-KEY is a string of length 1, it is used as a key in
278 `org-agenda-custom-commands' and triggers this command. If it is a
279 longer string is is used as a tags/todo match string.
280 Paramters are alternating variable names and values that will be bound
281 before running the agenda command.
283 The output gives a line for each selected agenda item. Each
284 item is a list of comma-separated values, like this:
286 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
288 category The category of the item
289 head The headline, without TODO kwd, TAGS and PRIORITY
290 type The type of the agenda entry, can be
291 todo selected in TODO match
292 tagsmatch selected in tags match
293 diary imported from diary
294 deadline a deadline on given date
295 scheduled scheduled on given date
296 timestamp entry has timestamp on given date
297 closed entry was closed on given date
298 upcoming-deadline warning about deadline
299 past-scheduled forwarded scheduled item
300 block entry has date block including g. date
301 todo The todo keyword, if any
302 tags All tags including inherited ones, separated by colons
303 date The relevant date, like 2007-2-14
304 time The time, like 15:00-16:50
305 extra Sting with extra planning info
306 priority-l The priority letter if any was given
307 priority-n The computed numerical priority
308 agenda-day The day in the agenda where this is listed
313 Not documented
318 Run all custom agenda commands that have a file argument.
323 Cycle through the files in `org-agenda-files'.
324 If the current buffer visits an agenda file, find the next one in the list.
325 If the current buffer does not, find the first agenda file.
330 Produce a daily/weekly view from all files in variable `org-agenda-files'.
331 The view will be for the current day or week, but from the overview buffer
332 you will be able to go to other days/weeks.
335 all unfinished TODO items will also be shown, before the agenda.
336 This feature is considered obsolete, please use the TODO list or a block
337 agenda instead.
339 With a numeric prefix argument in an interactive call, the agenda will
340 span INCLUDE-ALL days. Lisp programs should instead specify NDAYS to change
341 the number of days. NDAYS defaults to `org-agenda-ndays'.
343 START-DAY defaults to TODAY, or to the most recent match for the weekday
344 given in `org-agenda-start-on-weekday'.
349 Show all TODO entries from all agenda file in a single list.
350 The prefix arg can be used to select a specific TODO keyword and limit
352 for a keyword. A numeric prefix directly selects the Nth keyword in
353 `org-todo-keywords-1'.
358 Show all headlines for all `org-agenda-files' matching a TAGS criterion.
359 The prefix arg TODO-ONLY limits the search to TODO entries.
364 Create agenda view for projects that are stuck.
365 Stuck projects are project that have no next actions. For the definitions
366 of what a project is and how to check if it stuck, customize the variable
367 `org-stuck-projects'.
368 MATCH is being ignored.
373 Return diary information from org-files.
375 It accesses org files and extracts information from those files to be
376 listed in the diary. The function accepts arguments specifying what
377 items should be listed. The following arguments are allowed:
379 :timestamp List the headlines of items containing a date stamp or
380 date range matching the selected date. Deadlines will
381 also be listed, on the expiration day.
383 :sexp List entries resulting from diary-like sexps.
385 :deadline List any deadlines past due, or due within
386 `org-deadline-warning-days'. The listing occurs only
387 in the diary for *today*, not at any other date. If
388 an entry is marked DONE, it is no longer listed.
390 :scheduled List all items which are scheduled for the given date.
391 The diary for *today* also contains items which were
392 scheduled earlier and are not yet marked DONE.
394 :todo List all TODO items from the org-file. This may be a
395 long list - so this is not turned on by default.
396 Like deadlines, these entries only show up in the
397 diary for *today*, not at any other date.
399 The call in the diary file should look like this:
401 &%%(org-diary) ~/path/to/some/orgfile.org
403 Use a separate line for each org file to check. Or, if you omit the file name,
404 all files listed in `org-agenda-files' will be checked automatically:
406 &%%(org-diary)
408 If you don't give any arguments (as in the example above), the default
409 arguments (:deadline :scheduled :timestamp :sexp) are used.
410 So the example above may also be written as
412 &%%(org-diary :deadline :timestamp :sexp :scheduled)
414 The function expects the lisp variables `entry' and `date' to be provided
415 by the caller, because this is how the calendar works. Don't use this
416 function from a program - use `org-agenda-get-day-entries' instead.
421 Export current file as an iCalendar file.
422 The iCalendar file will be located in the same directory as the Org-mode
423 file, but with extension `.ics'.
428 Export all files in `org-agenda-files' to iCalendar .ics files.
429 Each iCalendar file will be located in the same directory as the Org-mode
430 file, but with extension `.ics'.
435 Export all files in `org-agenda-files' to a single combined iCalendar file.
436 The file is stored under the name `org-combined-agenda-icalendar-file'.
440 ;;;***
442 ;;;### (autoloads (org-publish-all org-publish-current-file org-publish-current-project
443 ;;;;;; org-publish) "org-publish" "org-publish.el" (18207 29024))
444 ;;; Generated autoloads from org-publish.el
447 Publish the project PROJECT-NAME.
452 Publish the project associated with the current file.
453 With prefix argument, force publishing all files in project.
458 Publish the current file.
459 With prefix argument, force publish the file.
464 Publish all projects.
465 With prefix argument, force publish all files.
469 ;;;***
471 ;;;### (autoloads (org-export-as-latex org-export-region-as-latex
472 ;;;;;; org-replace-region-by-latex org-export-as-latex-to-buffer
473 ;;;;;; org-export-as-latex-batch) "org-export-latex" "org-export-latex.el"
474 ;;;;;; (18252 7249))
475 ;;; Generated autoloads from org-export-latex.el
478 Call `org-export-as-latex', may be used in batch processing as
479 emacs --batch
480 --load=$HOME/lib/emacs/org.el
482 --visit=MyFile --funcall org-export-as-latex-batch
487 Call `org-exort-as-latex` with output to a temporary buffer.
488 No file is created. The prefix ARG is passed through to `org-export-as-latex'.
493 Replace the region from BEG to END with its LaTeX export.
494 It assumes the region has `org-mode' syntax, and then convert it to
495 LaTeX. This can be used in any buffer. For example, you could
496 write an itemized list in `org-mode' syntax in an LaTeX buffer and
497 then use this command to convert it.
502 Convert region from BEG to END in `org-mode' buffer to LaTeX.
503 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
504 contents, and only produce the region of converted text, useful for
505 cut-and-paste operations.
506 If BUFFER is a buffer or a string, use/create that buffer as a target
507 of the converted LaTeX. If BUFFER is the symbol `string', return the
508 produced LaTeX as a string and leave not buffer behind. For example,
509 a Lisp program could call this function in the following way:
511 (setq latex (org-export-region-as-latex beg end t 'string))
513 When called interactively, the output buffer is selected, and shown
514 in a window. A non-interactive call will only retunr the buffer.
519 Export current buffer to a LaTeX file.
520 If there is an active region, export only the region. The prefix
521 ARG specifies how many levels of the outline should become
522 headlines. The default is 3. Lower levels will be exported
523 depending on `org-export-latex-low-levels'. The default is to
524 convert them as description lists. When HIDDEN is non-nil, don't
525 display the LaTeX buffer. EXT-PLIST is a property list with
526 external parameters overriding org-mode's default settings, but
527 still inferior to file-local settings. When TO-BUFFER is
528 non-nil, create a buffer with that name and export to that
529 buffer. If TO-BUFFER is the symbol `string', don't leave any
530 buffer behind but just return the resulting LaTeX as a string.
531 When BODY-ONLY is set, don't produce the file header and footer,
532 simply return the content of \begin{document}...\end{document},
533 without even the \begin{document} and \end{document} commands.
537 ;;;***