add note about setting up $PATH
This commit is contained in:
parent
f32f2f8ad8
commit
a89a05ca9a
49
doc/FAQ.org
49
doc/FAQ.org
|
@ -19,6 +19,7 @@
|
|||
- [[#enable-navigation-by-visual-lines][Enable navigation by visual lines?]]
|
||||
- [[#disable-evilification-of-a-mode][Disable evilification of a mode?]]
|
||||
- [[#include-underscores-in-word-motions][Include underscores in word motions?]]
|
||||
- [[#setup-path][Setup =$PATH=?]]
|
||||
- [[#windows][Windows]]
|
||||
- [[#why-do-the-fonts-look-crappy-on-windows][Why do the fonts look crappy on Windows?]]
|
||||
- [[#why-is-there-no-spacemacs-logo-in-the-startup-buffer][Why is there no Spacemacs logo in the startup buffer?]]
|
||||
|
@ -187,6 +188,54 @@ mode:
|
|||
(modify-syntax-entry ?_ "w" python-mode-syntax-table))
|
||||
#+end_src
|
||||
|
||||
*** Setup =$PATH=?
|
||||
Some layers require certain tools to be available on your =$PATH=. This means
|
||||
that your =$PATH= must contain installation path for those tools. For example,
|
||||
you have installed some tools into =~/.local/bin= and want them to be available
|
||||
in Spacemacs. So you need to add =~/.local/bin= to your =$PATH=.
|
||||
|
||||
Users of =bash=, =zsh=, =sh= and other similar shells should add following line
|
||||
to their =.bashrc= (=.zshrc=, =.profile= or your shell's equivalent). Note that
|
||||
the =export= part is very important.
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
export PATH=~/.local/bin:$PATH
|
||||
#+END_SRC
|
||||
|
||||
Users of =fish= should add following line to their =config.fish= file (should be
|
||||
in =$XDG_CONFIG_HOME= or it's default value - =~/.config/fish=). Note that =-x=
|
||||
part is very important.
|
||||
|
||||
#+BEGIN_SRC
|
||||
set -x PATH ~/.local/bin $PATH
|
||||
#+END_SRC
|
||||
|
||||
Users of other shells should consult it's documentation on how to setup =$PATH=
|
||||
variable (with export to environment).
|
||||
|
||||
So now, =~/.local/bin= should be available in your =$PATH=. You can verify that
|
||||
by calling =$ echo $PATH=. But you also should verify that =$PATH= is set
|
||||
properly in your environment. To do so call following command in your terminal.
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
$ env | grep "PATH"
|
||||
#+END_SRC
|
||||
|
||||
This is the value that will be used by Emacs. So it must contain =~/.local/bin=.
|
||||
|
||||
After that you can run Spacemacs and check that it properly gets the value of
|
||||
=$PATH= by running =M-: (getenv "PATH")=.
|
||||
|
||||
Note that having =~/.local.bin= in your =$PATH= means also that it's possible to
|
||||
run terminal and call tools from =~/.local/bin= without specifying their full
|
||||
path. Under certain conditions you might want to avoid modifying your =$PATH=.
|
||||
In that case you have an option to update value of =exec-path= in
|
||||
=dotspacemacs/user-config= function of your =.spacemacs= file.
|
||||
|
||||
#+BEGIN_SRC
|
||||
(add-to-list 'exec-path "~/.local/bin/")
|
||||
#+END_SRC
|
||||
|
||||
** Windows
|
||||
*** Why do the fonts look crappy on Windows?
|
||||
You can install [[https://code.google.com/p/mactype/][MacType]] on Windows to get very nice looking fonts. It is
|
||||
|
|
|
@ -2,10 +2,10 @@
|
|||
|
||||
* Table of Contents :TOC@4:
|
||||
- [[#description][Description]]
|
||||
- [[#some-features][Some features:]]
|
||||
- [[#some-features][Some features:]]
|
||||
- [[#install][Install]]
|
||||
- [[#layer][Layer]]
|
||||
- [[#agda][Agda]]
|
||||
- [[#layer][Layer]]
|
||||
- [[#agda][Agda]]
|
||||
- [[#key-bindings][Key bindings]]
|
||||
|
||||
* Description
|
||||
|
@ -15,7 +15,7 @@ This layer adds support for the [[http://wiki.portal.chalmers.se/agda/pmwiki.php
|
|||
** Some features:
|
||||
- Faces redefined to correctly play with themes.
|
||||
- Spacemacs bindings to Agda's interactive tools.
|
||||
|
||||
|
||||
*This layer is in construction, it needs your contributions and bug reports.*
|
||||
|
||||
* Install
|
||||
|
@ -36,7 +36,9 @@ Quick instructions to install Agda assuming you have cabal installed:
|
|||
cabal install alex happy "cpphs < 1.19" agda
|
||||
#+END_SRC
|
||||
|
||||
Then check that =agda= is available on your =PATH= and seen by Emacs.
|
||||
Then check that =agda= is available on your =$PATH= and seen by Emacs. For
|
||||
information about setting up =$PATH=, checkout corresponding section in FAQ
|
||||
(~SPC f e h $PATH RET~).
|
||||
|
||||
* Key bindings
|
||||
|
||||
|
|
|
@ -33,7 +33,9 @@ You will need =gocode= and =godef=:
|
|||
go get -u -v golang.org/x/tools/cmd/oracle
|
||||
#+END_SRC
|
||||
|
||||
Make sure that =gocode= executable is in your PATH.
|
||||
Make sure that =gocode= executable is in your PATH. For information about
|
||||
setting up =$PATH=, checkout corresponding section in FAQ (~SPC f e h $PATH
|
||||
RET~).
|
||||
|
||||
For best results, make sure that the =auto-completion= and =syntax-checking=
|
||||
layers are enabled as well.
|
||||
|
|
|
@ -63,6 +63,7 @@ following command:
|
|||
#+END_SRC
|
||||
|
||||
** Setup PATH
|
||||
|
||||
First of all make sure that your =$PATH= contains installation path for Haskell
|
||||
tools like =ghc=, =ghci= etc. It depends on how you have installed =ghc=. But
|
||||
you can always check it by calling =$ which ghc= in your terminal. =Stack= users
|
||||
|
@ -74,35 +75,8 @@ packages. If you are using =cabal= it should be =~/.cabal/bin= or
|
|||
=/Users/<username>/Library/Haskell/bin= (for 'Haskell for Mac' users). If you
|
||||
are using =stack= then it should be =~/.local/bin=.
|
||||
|
||||
If you are using =bash=, =sh= or =zsh=, you could update your =$PATH= by using
|
||||
following command:
|
||||
|
||||
#+BEGIN_SRC sh
|
||||
$ export PATH=~/.local/bin:$PATH
|
||||
#+END_SRC
|
||||
|
||||
If you are using =fish=, you could update your =$PATH= by using following
|
||||
command:
|
||||
|
||||
#+BEGIN_SRC fish
|
||||
$ set -x PATH ~/.local/bin $PATH
|
||||
#+END_SRC
|
||||
|
||||
After you setup your =$PATH=, emacs should automatically pick it's value (after
|
||||
restart).
|
||||
|
||||
_Alternatively_, you can add path to the Emacs =exec-path= variable in the
|
||||
=dotspacemacs/user-config= function of your =.spacemacs= file:
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(add-to-list 'exec-path "~/.cabal/bin/")
|
||||
#+END_SRC
|
||||
|
||||
Or for =stack= users:
|
||||
|
||||
#+BEGIN_SRC emacs-lisp
|
||||
(add-to-list 'exec-path "~/.local/bin/")
|
||||
#+END_SRC
|
||||
For information about setting up =$PATH=, checkout corresponding section in FAQ
|
||||
(~SPC f e h $PATH RET~).
|
||||
|
||||
** OS X
|
||||
Note that =emacs.app= for OS X does not pick up =$PATH= from =~/.bashrc= or
|
||||
|
|
|
@ -5,9 +5,9 @@
|
|||
* Table of Contents :TOC@4:
|
||||
- [[#description][Description]]
|
||||
- [[#install][Install]]
|
||||
- [[#layer][Layer]]
|
||||
- [[#geeknote][geeknote]]
|
||||
- [[#geeknoteel][geeknote.el]]
|
||||
- [[#layer][Layer]]
|
||||
- [[#geeknote][geeknote]]
|
||||
- [[#geeknoteel][geeknote.el]]
|
||||
- [[#key-bindings][Key Bindings]]
|
||||
|
||||
* Description
|
||||
|
@ -47,9 +47,10 @@ installing =geeknote=:
|
|||
$ geeknote settings --editor "emacsclient"
|
||||
#+END_SRC
|
||||
|
||||
If you would prefer to customize the geeknote command to be used
|
||||
such as specifying the path to the geeknote python script, please
|
||||
refer to the =geeknote.el= [[https://github.com/avendael/emacs-geeknote][documentation]].
|
||||
If you would prefer to customize the geeknote command to be used such as
|
||||
specifying the path to the geeknote python script, please refer to the
|
||||
=geeknote.el= [[https://github.com/avendael/emacs-geeknote][documentation]]. For more information about setting up =$PATH=,
|
||||
checkout corresponding section in FAQ (~SPC f e h $PATH RET~).
|
||||
|
||||
* Key Bindings
|
||||
|
||||
|
|
Loading…
Reference in New Issue