code.delx.au - gnu-emacs-elpa/blob - packages/excorporate/excorporate.info

   1 This is excorporate.info, produced by makeinfo version 6.0 from
   2 excorporate.texi.
   3
   4 Copyright (C) 2016 Free Software Foundation, Inc.
   5
   6      Permission is granted to copy, distribute and/or modify this
   7      document under the terms of the GNU Free Documentation License,
   8      Version 1.2 or any later version published by the Free Software
   9      Foundation; with no Invariant Sections, with the Front-Cover, or
  10      Back-Cover Texts.  A copy of the license is included in the section
  11      entitled "GNU Free Documentation License" in the Emacs manual.
  12
  13      This document is part of a collection distributed under the GNU
  14      Free Documentation License.  If you want to distribute this
  15      document separately from the collection, you can do so by adding a
  16      copy of the license to the document, as described in section 6 of
  17      the license.
  18
  19      All Emacs Lisp code contained in this document may be used,
  20      distributed, and modified without restriction.
  21 INFO-DIR-SECTION Emacs
  22 START-INFO-DIR-ENTRY
  23 * Excorporate: (excorporate).  Exchange Web Services integration for Emacs.
  24 END-INFO-DIR-ENTRY
  25
  26 \1f
  27 File: excorporate.info,  Node: Top,  Next: Installation,  Up: (dir)
  28
  29 Excorporate Manual
  30 ******************
  31
  32 Excorporate provides Exchange Web Services (EWS) support for Emacs.
  33
  34    If the Exchange server you access is configured to provide EWS
  35 support, then there's a 76% chance that Excorporate will enable you to
  36 retrieve your calendar entries from the comfort of Emacs.
  37
  38    The 24% failure rate is because accessing - in particular,
  39 authenticating against - an Exchange server can be challenging.
  40
  41    Known to fail are Kerberos/GSSAPI authentication and accessing the
  42 server through a proxy
  43 (<https://debbugs.gnu.org/cgi/bugreport.cgi?bug=10>).
  44
  45    Patches are welcome to enable more of these access scenarios.
  46
  47 * Menu:
  48
  49 * Installation::                Getting and installing 'excorporate'.
  50 * Configuration::               Configuring 'excorporate'.
  51 * Usage::                       Using 'excorporate'.
  52 * Troubleshooting::             Debugging why a connection failed
  53
  54 \1f
  55 File: excorporate.info,  Node: Installation,  Next: Configuration,  Prev: Top,  Up: Top
  56
  57 1 Installation
  58 **************
  59
  60 Excorporate works on Emacs versions >= 24.1.
  61
  62 Install 'excorporate' from the GNU ELPA repository:
  63
  64    'M-x package-install RET excorporate'
  65
  66 \1f
  67 File: excorporate.info,  Node: Configuration,  Next: Usage,  Prev: Installation,  Up: Top
  68
  69 2 Configuration
  70 ***************
  71
  72 Ideally you won't need to configure Excorporate at all.  On friendly
  73 Exchange setups, Excorporate can discover the EWS URL automatically.
  74
  75 First try:
  76
  77    'M-x excorporate'
  78
  79 which will prompt you for the Exchange account email address.  Follow
  80 the prompts and if all goes well, you'll see a message in the minibuffer
  81 or in *Messages* saying that the connection is ready.
  82
  83    If autodiscovery runs out of URLs to try, then customize
  84 'excorporate-configuration':
  85
  86    'M-x customize-variable RET excorporate-configuration'
  87
  88    From the value menu select "Skip autodiscovery".  This allows you to
  89 enter the Exchange account email address and the EWS URL directly.  The
  90 EWS URL is of the form 'https://mail.gnu.org/ews/exchange.asmx'.
  91
  92    After saving the configuration, try 'M-x excorporate' again.
  93
  94    If that doesn't work, then you're probably out of luck, or you'll
  95 have to start a troubleshooting deep dive (*note Troubleshooting::).
  96
  97 \1f
  98 File: excorporate.info,  Node: Usage,  Next: Troubleshooting,  Prev: Configuration,  Up: Top
  99
 100 3 Usage
 101 *******
 102
 103 Excorporate binds 'e' in '*Calendar*' buffers.  Open the calendar with:
 104
 105    'M-x calendar'
 106
 107 move the cursor to the date you want to see meetings for, and press 'e'.
 108 This will show the meetings in a temporary read-only Org Mode buffer
 109 named '*Excorporate*'.
 110
 111 \1f
 112 File: excorporate.info,  Node: Troubleshooting,  Prev: Usage,  Up: Top
 113
 114 4 Troubleshooting
 115 *****************
 116
 117 First, you'll want to double-check that the Exchange server you're
 118 trying to access provides EWS support.  If it doesn't, Excorporate can't
 119 do anything for you.  Before asking your Exchange administrator, check
 120 intranet wikis and so forth; other users of non-standard clients may
 121 have already found the EWS URL.
 122
 123    The buffer '*fsm-debug*' shows 'excorporate' state transitions and
 124 should provide details of where things went wrong.
 125
 126    Also check '*Messages*' for anything obvious.
 127
 128    If you suspect something wrong with accessing the EWS URL, try
 129 setting 'url-debug' to t and retry 'M-x excorporate', then check the
 130 '*URL-DEBUG*' buffer for output.
 131
 132    If you suspect NTLM authentication is failing, as a long shot, you
 133 might try setting 'ntlm-compatibility-level' to 0 and retrying 'M-x
 134 excorporate'.
 135
 136    Excorporate's dependencies implement the tricky elements of
 137 asynchronous Exchange access: a state machine ('fsm'), TLS negotiation
 138 ('gnutls'), NTLM authentication ('ntlm' and 'url-http-ntlm') and SOAP
 139 communication ('soap-client').
 140
 141
 142 \1f
 143 Tag Table:
 144 Node: Top\7f1103
 145 Node: Installation\7f2077
 146 Node: Configuration\7f2340
 147 Node: Usage\7f3400
 148 Node: Troubleshooting\7f3771
 149 \1f
 150 End Tag Table