org-install.el

   1 \f
   2 ;;;### (autoloads (org-export-icalendar-combine-agenda-files org-export-icalendar-all-agenda-files
   3 ;;;;;;  org-export-icalendar-this-file org-diary org-agenda-list-stuck-projects
   4 ;;;;;;  org-tags-view org-todo-list org-agenda-list org-cycle-agenda-files
   5 ;;;;;;  org-batch-store-agenda-views org-store-agenda-views org-batch-agenda-csv
   6 ;;;;;;  org-batch-agenda org-agenda org-agenda-to-appt org-remember-handler
   7 ;;;;;;  org-remember org-remember-apply-template org-remember-annotation
   8 ;;;;;;  org-remember-insinuate org-open-at-point-global org-insert-link-global
   9 ;;;;;;  org-store-link orgtbl-mode turn-on-orgtbl org-run-like-in-org-mode
  10 ;;;;;;  turn-on-orgstruct++ turn-on-orgstruct orgstruct-mode org-global-cycle
  11 ;;;;;;  org-cycle org-mode) "org" "org.el" (18344 16141))
  12 ;;; Generated autoloads from org.el
  13
  14 (autoload 'org-mode "org" "\
  15 Outline-based notes management and organizer, alias
  16 \"Carsten's outline-mode for keeping track of everything.\"
  17
  18 Org-mode develops organizational tasks around a NOTES file which
  19 contains information about projects as plain text.  Org-mode is
  20 implemented on top of outline-mode, which is ideal to keep the content
  21 of large files well structured.  It supports ToDo items, deadlines and
  22 time stamps, which magically appear in the diary listing of the Emacs
  23 calendar.  Tables are easily created with a built-in table editor.
  24 Plain text URL-like links connect to websites, emails (VM), Usenet
  25 messages (Gnus), BBDB entries, and any files related to the project.
  26 For printing and sharing of notes, an Org-mode file (or a part of it)
  27 can be exported as a structured ASCII or HTML file.
  28
  29 The following commands are available:
  30
  31 \\{org-mode-map}
  32
  33 \(fn)" t nil)
  34
  35 (autoload 'org-cycle "org" "\
  36 Visibility cycling for Org-mode.
  37
  38 - When this function is called with a prefix argument, rotate the entire
  39   buffer through 3 states (global cycling)
  40   1. OVERVIEW: Show only top-level headlines.
  41   2. CONTENTS: Show all headlines of all levels, but no body text.
  42   3. SHOW ALL: Show everything.
  43
  44 - When point is at the beginning of a headline, rotate the subtree started
  45   by this line through 3 different states (local cycling)
  46   1. FOLDED:   Only the main headline is shown.
  47   2. CHILDREN: The main headline and the direct children are shown.
  48                From this state, you can move to one of the children
  49                and zoom in further.
  50   3. SUBTREE:  Show the entire subtree, including body text.
  51
  52 - When there is a numeric prefix, go up to a heading with level ARG, do
  53   a `show-subtree' and return to the previous cursor position.  If ARG
  54   is negative, go up that many levels.
  55
  56 - When point is not at the beginning of a headline, execute
  57   `indent-relative', like TAB normally does.  See the option
  58   `org-cycle-emulate-tab' for details.
  59
  60 - Special case: if point is at the beginning of the buffer and there is
  61   no headline in line 1, this function will act as if called with prefix arg.
  62   But only if also the variable `org-cycle-global-at-bob' is t.
  63
  64 \(fn &optional ARG)" t nil)
  65
  66 (autoload 'org-global-cycle "org" "\
  67 Cycle the global visibility.  For details see `org-cycle'.
  68
  69 \(fn &optional ARG)" t nil)
  70
  71 (autoload 'orgstruct-mode "org" "\
  72 Toggle the minor more `orgstruct-mode'.
  73 This mode is for using Org-mode structure commands in other modes.
  74 The following key behave as if Org-mode was active, if the cursor
  75 is on a headline, or on a plain list item (both in the definition
  76 of Org-mode).
  77
  78 M-up        Move entry/item up
  79 M-down      Move entry/item down
  80 M-left      Promote
  81 M-right     Demote
  82 M-S-up      Move entry/item up
  83 M-S-down    Move entry/item down
  84 M-S-left    Promote subtree
  85 M-S-right   Demote subtree
  86 M-q         Fill paragraph and items like in Org-mode
  87 C-c ^       Sort entries
  88 C-c -       Cycle list bullet
  89 TAB         Cycle item visibility
  90 M-RET       Insert new heading/item
  91 S-M-RET     Insert new TODO heading / Chekbox item
  92 C-c C-c     Set tags / toggle checkbox
  93
  94 \(fn &optional ARG)" t nil)
  95
  96 (autoload 'turn-on-orgstruct "org" "\
  97 Unconditionally turn on `orgstruct-mode'.
  98
  99 \(fn)" nil nil)
 100
 101 (autoload 'turn-on-orgstruct++ "org" "\
 102 Unconditionally turn on `orgstruct-mode', and force org-mode indentations.
 103 In addition to setting orgstruct-mode, this also exports all indentation and
 104 autofilling variables from org-mode into the buffer.  Note that turning
 105 off orgstruct-mode will *not* remove these additional settings.
 106
 107 \(fn)" nil nil)
 108
 109 (autoload 'org-run-like-in-org-mode "org" "\
 110 Not documented
 111
 112 \(fn CMD)" nil nil)
 113
 114 (autoload 'turn-on-orgtbl "org" "\
 115 Unconditionally turn on `orgtbl-mode'.
 116
 117 \(fn)" nil nil)
 118
 119 (autoload 'orgtbl-mode "org" "\
 120 The `org-mode' table editor as a minor mode for use in other modes.
 121
 122 \(fn &optional ARG)" t nil)
 123
 124 (autoload 'org-store-link "org" "\
 125 \\<org-mode-map>Store an org-link to the current location.
 126 This link can later be inserted into an org-buffer with
 127 \\[org-insert-link].
 128 For some link types, a prefix arg is interpreted:
 129 For links to usenet articles, arg negates `org-usenet-links-prefer-google'.
 130 For file links, arg negates `org-context-in-file-links'.
 131
 132 \(fn ARG)" t nil)
 133
 134 (autoload 'org-insert-link-global "org" "\
 135 Insert a link like Org-mode does.
 136 This command can be called in any mode to insert a link in Org-mode syntax.
 137
 138 \(fn)" t nil)
 139
 140 (autoload 'org-open-at-point-global "org" "\
 141 Follow a link like Org-mode does.
 142 This command can be called in any mode to follow a link that has
 143 Org-mode syntax.
 144
 145 \(fn)" t nil)
 146
 147 (autoload 'org-remember-insinuate "org" "\
 148 Setup remember.el for use wiht Org-mode.
 149
 150 \(fn)" nil nil)
 151
 152 (autoload 'org-remember-annotation "org" "\
 153 Return a link to the current location as an annotation for remember.el.
 154 If you are using Org-mode files as target for data storage with
 155 remember.el, then the annotations should include a link compatible with the
 156 conventions in Org-mode.  This function returns such a link.
 157
 158 \(fn)" nil nil)
 159
 160 (autoload 'org-remember-apply-template "org" "\
 161 Initialize *remember* buffer with template, invoke `org-mode'.
 162 This function should be placed into `remember-mode-hook' and in fact requires
 163 to be run from that hook to function properly.
 164
 165 \(fn &optional USE-CHAR SKIP-INTERACTIVE)" nil nil)
 166
 167 (autoload 'org-remember "org" "\
 168 Call `remember'.  If this is already a remember buffer, re-apply template.
 169 If there is an active region, make sure remember uses it as initial content
 170 of the remember buffer.
 171
 172 When called interactively with a `C-u' prefix argument GOTO, don't remember
 173 anything, just go to the file/headline where the selected template usually
 174 stores its notes.  With a double prefix arg `C-u C-u', go to the last
 175 note stored by remember.
 176
 177 Lisp programs can set ORG-FORCE-REMEMBER-TEMPLATE-CHAR to a character
 178 associated with a template in `org-remember-templates'.
 179
 180 \(fn &optional GOTO ORG-FORCE-REMEMBER-TEMPLATE-CHAR)" t nil)
 181
 182 (autoload 'org-remember-handler "org" "\
 183 Store stuff from remember.el into an org file.
 184 First prompts for an org file.  If the user just presses return, the value
 185 of `org-default-notes-file' is used.
 186 Then the command offers the headings tree of the selected file in order to
 187 file the text at a specific location.
 188 You can either immediately press RET to get the note appended to the
 189 file, or you can use vertical cursor motion and visibility cycling (TAB) to
 190 find a better place.  Then press RET or <left> or <right> in insert the note.
 191
 192 Key      Cursor position   Note gets inserted
 193 -----------------------------------------------------------------------------
 194 RET      buffer-start      as level 1 heading at end of file
 195 RET      on headline       as sublevel of the heading at cursor
 196 RET      no heading        at cursor position, level taken from context.
 197                            Or use prefix arg to specify level manually.
 198 <left>   on headline       as same level, before current heading
 199 <right>  on headline       as same level, after current heading
 200
 201 So the fastest way to store the note is to press RET RET to append it to
 202 the default file.  This way your current train of thought is not
 203 interrupted, in accordance with the principles of remember.el.
 204 You can also get the fast execution without prompting by using
 205 C-u C-c C-c to exit the remember buffer.  See also the variable
 206 `org-remember-store-without-prompt'.
 207
 208 Before being stored away, the function ensures that the text has a
 209 headline, i.e. a first line that starts with a \"*\".  If not, a headline
 210 is constructed from the current date and some additional data.
 211
 212 If the variable `org-adapt-indentation' is non-nil, the entire text is
 213 also indented so that it starts in the same column as the headline
 214 \(i.e. after the stars).
 215
 216 See also the variable `org-reverse-note-order'.
 217
 218 \(fn)" nil nil)
 219
 220 (autoload 'org-agenda-to-appt "org" "\
 221 Activate appointments found in `org-agenda-files'.
 222 When prefixed, prompt for a regular expression and use it as a
 223 filter: only add entries if they match this regular expression.
 224
 225 FILTER can be a string. In this case, use this string as a
 226 regular expression to filter results.
 227
 228 FILTER can also be an alist, with the car of each cell being
 229 either 'headline or 'category.  For example:
 230
 231   '((headline \"IMPORTANT\")
 232     (category \"Work\"))
 233
 234 will only add headlines containing IMPORTANT or headlines
 235 belonging to the category \"Work\".
 236
 237 \(fn &optional FILTER)" t nil)
 238
 239 (autoload 'org-agenda "org" "\
 240 Dispatch agenda commands to collect entries to the agenda buffer.
 241 Prompts for a command to execute.  Any prefix arg will be passed
 242 on to the selected command.  The default selections are:
 243
 244 a     Call `org-agenda-list' to display the agenda for current day or week.
 245 t     Call `org-todo-list' to display the global todo list.
 246 T     Call `org-todo-list' to display the global todo list, select only
 247       entries with a specific TODO keyword (the user gets a prompt).
 248 m     Call `org-tags-view' to display headlines with tags matching
 249       a condition  (the user is prompted for the condition).
 250 M     Like `m', but select only TODO entries, no ordinary headlines.
 251 L     Create a timeline for the current buffer.
 252 e     Export views to associated files.
 253
 254 More commands can be added by configuring the variable
 255 `org-agenda-custom-commands'.  In particular, specific tags and TODO keyword
 256 searches can be pre-defined in this way.
 257
 258 If the current buffer is in Org-mode and visiting a file, you can also
 259 first press `<' once to indicate that the agenda should be temporarily
 260 \(until the next use of \\[org-agenda]) restricted to the current file.
 261 Pressing `<' twice means to restrict to the current subtree or region
 262 \(if active).
 263
 264 \(fn ARG &optional KEYS RESTRICTION)" t nil)
 265
 266 (autoload 'org-batch-agenda "org" "\
 267 Run an agenda command in batch mode and send the result to STDOUT.
 268 If CMD-KEY is a string of length 1, it is used as a key in
 269 `org-agenda-custom-commands' and triggers this command.  If it is a
 270 longer string it is used as a tags/todo match string.
 271 Paramters are alternating variable names and values that will be bound
 272 before running the agenda command.
 273
 274 \(fn CMD-KEY &rest PARAMETERS)" nil (quote macro))
 275
 276 (autoload 'org-batch-agenda-csv "org" "\
 277 Run an agenda command in batch mode and send the result to STDOUT.
 278 If CMD-KEY is a string of length 1, it is used as a key in
 279 `org-agenda-custom-commands' and triggers this command.  If it is a
 280 longer string it is used as a tags/todo match string.
 281 Paramters are alternating variable names and values that will be bound
 282 before running the agenda command.
 283
 284 The output gives a line for each selected agenda item.  Each
 285 item is a list of comma-separated values, like this:
 286
 287 category,head,type,todo,tags,date,time,extra,priority-l,priority-n
 288
 289 category     The category of the item
 290 head         The headline, without TODO kwd, TAGS and PRIORITY
 291 type         The type of the agenda entry, can be
 292                 todo               selected in TODO match
 293                 tagsmatch          selected in tags match
 294                 diary              imported from diary
 295                 deadline           a deadline on given date
 296                 scheduled          scheduled on given date
 297                 timestamp          entry has timestamp on given date
 298                 closed             entry was closed on given date
 299                 upcoming-deadline  warning about deadline
 300                 past-scheduled     forwarded scheduled item
 301                 block              entry has date block including g. date
 302 todo         The todo keyword, if any
 303 tags         All tags including inherited ones, separated by colons
 304 date         The relevant date, like 2007-2-14
 305 time         The time, like 15:00-16:50
 306 extra        Sting with extra planning info
 307 priority-l   The priority letter if any was given
 308 priority-n   The computed numerical priority
 309 agenda-day   The day in the agenda where this is listed
 310
 311 \(fn CMD-KEY &rest PARAMETERS)" nil (quote macro))
 312
 313 (autoload 'org-store-agenda-views "org" "\
 314 Not documented
 315
 316 \(fn &rest PARAMETERS)" t nil)
 317
 318 (autoload 'org-batch-store-agenda-views "org" "\
 319 Run all custom agenda commands that have a file argument.
 320
 321 \(fn &rest PARAMETERS)" nil (quote macro))
 322
 323 (autoload 'org-cycle-agenda-files "org" "\
 324 Cycle through the files in `org-agenda-files'.
 325 If the current buffer visits an agenda file, find the next one in the list.
 326 If the current buffer does not, find the first agenda file.
 327
 328 \(fn)" t nil)
 329
 330 (autoload 'org-agenda-list "org" "\
 331 Produce a daily/weekly view from all files in variable `org-agenda-files'.
 332 The view will be for the current day or week, but from the overview buffer
 333 you will be able to go to other days/weeks.
 334
 335 With one \\[universal-argument] prefix argument INCLUDE-ALL,
 336 all unfinished TODO items will also be shown, before the agenda.
 337 This feature is considered obsolete, please use the TODO list or a block
 338 agenda instead.
 339
 340 With a numeric prefix argument in an interactive call, the agenda will
 341 span INCLUDE-ALL days.  Lisp programs should instead specify NDAYS to change
 342 the number of days.  NDAYS defaults to `org-agenda-ndays'.
 343
 344 START-DAY defaults to TODAY, or to the most recent match for the weekday
 345 given in `org-agenda-start-on-weekday'.
 346
 347 \(fn &optional INCLUDE-ALL START-DAY NDAYS)" t nil)
 348
 349 (autoload 'org-todo-list "org" "\
 350 Show all TODO entries from all agenda file in a single list.
 351 The prefix arg can be used to select a specific TODO keyword and limit
 352 the list to these.  When using \\[universal-argument], you will be prompted
 353 for a keyword.  A numeric prefix directly selects the Nth keyword in
 354 `org-todo-keywords-1'.
 355
 356 \(fn ARG)" t nil)
 357
 358 (autoload 'org-tags-view "org" "\
 359 Show all headlines for all `org-agenda-files' matching a TAGS criterion.
 360 The prefix arg TODO-ONLY limits the search to TODO entries.
 361
 362 \(fn &optional TODO-ONLY MATCH)" t nil)
 363
 364 (autoload 'org-agenda-list-stuck-projects "org" "\
 365 Create agenda view for projects that are stuck.
 366 Stuck projects are project that have no next actions.  For the definitions
 367 of what a project is and how to check if it stuck, customize the variable
 368 `org-stuck-projects'.
 369 MATCH is being ignored.
 370
 371 \(fn &rest IGNORE)" t nil)
 372
 373 (autoload 'org-diary "org" "\
 374 Return diary information from org-files.
 375 This function can be used in a \"sexp\" diary entry in the Emacs calendar.
 376 It accesses org files and extracts information from those files to be
 377 listed in the diary.  The function accepts arguments specifying what
 378 items should be listed.  The following arguments are allowed:
 379
 380    :timestamp    List the headlines of items containing a date stamp or
 381                  date range matching the selected date.  Deadlines will
 382                  also be listed, on the expiration day.
 383
 384    :sexp         List entries resulting from diary-like sexps.
 385
 386    :deadline     List any deadlines past due, or due within
 387                  `org-deadline-warning-days'.  The listing occurs only
 388                  in the diary for *today*, not at any other date.  If
 389                  an entry is marked DONE, it is no longer listed.
 390
 391    :scheduled    List all items which are scheduled for the given date.
 392                  The diary for *today* also contains items which were
 393                  scheduled earlier and are not yet marked DONE.
 394
 395    :todo         List all TODO items from the org-file.  This may be a
 396                  long list - so this is not turned on by default.
 397                  Like deadlines, these entries only show up in the
 398                  diary for *today*, not at any other date.
 399
 400 The call in the diary file should look like this:
 401
 402    &%%(org-diary) ~/path/to/some/orgfile.org
 403
 404 Use a separate line for each org file to check.  Or, if you omit the file name,
 405 all files listed in `org-agenda-files' will be checked automatically:
 406
 407    &%%(org-diary)
 408
 409 If you don't give any arguments (as in the example above), the default
 410 arguments (:deadline :scheduled :timestamp :sexp) are used.
 411 So the example above may also be written as
 412
 413    &%%(org-diary :deadline :timestamp :sexp :scheduled)
 414
 415 The function expects the lisp variables `entry' and `date' to be provided
 416 by the caller, because this is how the calendar works.  Don't use this
 417 function from a program - use `org-agenda-get-day-entries' instead.
 418
 419 \(fn &rest ARGS)" nil nil)
 420
 421 (autoload 'org-export-icalendar-this-file "org" "\
 422 Export current file as an iCalendar file.
 423 The iCalendar file will be located in the same directory as the Org-mode
 424 file, but with extension `.ics'.
 425
 426 \(fn)" t nil)
 427
 428 (autoload 'org-export-icalendar-all-agenda-files "org" "\
 429 Export all files in `org-agenda-files' to iCalendar .ics files.
 430 Each iCalendar file will be located in the same directory as the Org-mode
 431 file, but with extension `.ics'.
 432
 433 \(fn)" t nil)
 434
 435 (autoload 'org-export-icalendar-combine-agenda-files "org" "\
 436 Export all files in `org-agenda-files' to a single combined iCalendar file.
 437 The file is stored under the name `org-combined-agenda-icalendar-file'.
 438
 439 \(fn)" t nil)
 440
 441 ;;;***
 442 \f
 443 ;;;### (autoloads (org-publish-all org-publish-current-file org-publish-current-project
 444 ;;;;;;  org-publish) "org-publish" "org-publish.el" (18337 60100))
 445 ;;; Generated autoloads from org-publish.el
 446
 447 (autoload 'org-publish "org-publish" "\
 448 Publish the project PROJECT-NAME.
 449
 450 \(fn PROJECT-NAME &optional FORCE)" t nil)
 451
 452 (autoload 'org-publish-current-project "org-publish" "\
 453 Publish the project associated with the current file.
 454 With prefix argument, force publishing all files in project.
 455
 456 \(fn &optional FORCE)" t nil)
 457
 458 (autoload 'org-publish-current-file "org-publish" "\
 459 Publish the current file.
 460 With prefix argument, force publish the file.
 461
 462 \(fn &optional FORCE)" t nil)
 463
 464 (autoload 'org-publish-all "org-publish" "\
 465 Publish all projects.
 466 With prefix argument, force publish all files.
 467
 468 \(fn &optional FORCE)" t nil)
 469
 470 ;;;***
 471 \f
 472 ;;;### (autoloads (org-export-as-latex org-export-region-as-latex
 473 ;;;;;;  org-replace-region-by-latex org-export-as-latex-to-buffer
 474 ;;;;;;  org-export-as-latex-batch) "org-export-latex" "org-export-latex.el"
 475 ;;;;;;  (18337 60100))
 476 ;;; Generated autoloads from org-export-latex.el
 477
 478 (autoload 'org-export-as-latex-batch "org-export-latex" "\
 479 Call `org-export-as-latex', may be used in batch processing as
 480 emacs   --batch
 481         --load=$HOME/lib/emacs/org.el
 482         --eval \"(setq org-export-headline-levels 2)\"
 483         --visit=MyFile --funcall org-export-as-latex-batch
 484
 485 \(fn)" nil nil)
 486
 487 (autoload 'org-export-as-latex-to-buffer "org-export-latex" "\
 488 Call `org-exort-as-latex` with output to a temporary buffer.
 489 No file is created.  The prefix ARG is passed through to `org-export-as-latex'.
 490
 491 \(fn ARG)" t nil)
 492
 493 (autoload 'org-replace-region-by-latex "org-export-latex" "\
 494 Replace the region from BEG to END with its LaTeX export.
 495 It assumes the region has `org-mode' syntax, and then convert it to
 496 LaTeX.  This can be used in any buffer.  For example, you could
 497 write an itemized list in `org-mode' syntax in an LaTeX buffer and
 498 then use this command to convert it.
 499
 500 \(fn BEG END)" t nil)
 501
 502 (autoload 'org-export-region-as-latex "org-export-latex" "\
 503 Convert region from BEG to END in `org-mode' buffer to LaTeX.
 504 If prefix arg BODY-ONLY is set, omit file header, footer, and table of
 505 contents, and only produce the region of converted text, useful for
 506 cut-and-paste operations.
 507 If BUFFER is a buffer or a string, use/create that buffer as a target
 508 of the converted LaTeX.  If BUFFER is the symbol `string', return the
 509 produced LaTeX as a string and leave not buffer behind.  For example,
 510 a Lisp program could call this function in the following way:
 511
 512   (setq latex (org-export-region-as-latex beg end t 'string))
 513
 514 When called interactively, the output buffer is selected, and shown
 515 in a window.  A non-interactive call will only retunr the buffer.
 516
 517 \(fn BEG END &optional BODY-ONLY BUFFER)" t nil)
 518
 519 (autoload 'org-export-as-latex "org-export-latex" "\
 520 Export current buffer to a LaTeX file.
 521 If there is an active region, export only the region.  The prefix
 522 ARG specifies how many levels of the outline should become
 523 headlines.  The default is 3.  Lower levels will be exported
 524 depending on `org-export-latex-low-levels'.  The default is to
 525 convert them as description lists.  When HIDDEN is non-nil, don't
 526 display the LaTeX buffer.  EXT-PLIST is a property list with
 527 external parameters overriding org-mode's default settings, but
 528 still inferior to file-local settings.  When TO-BUFFER is
 529 non-nil, create a buffer with that name and export to that
 530 buffer.  If TO-BUFFER is the symbol `string', don't leave any
 531 buffer behind but just return the resulting LaTeX as a string.
 532 When BODY-ONLY is set, don't produce the file header and footer,
 533 simply return the content of \begin{document}...\end{document},
 534 without even the \begin{document} and \end{document} commands.
 535
 536 \(fn ARG &optional HIDDEN EXT-PLIST TO-BUFFER BODY-ONLY)" t nil)
 537
 538 ;;;***
 539
 540 (provide (quote org-install))