TakeV
/
spacemacs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clean up PATH documentation

This commit is contained in:
Eivind Fonn 2015-10-29 13:41:05 +01:00
parent a89a05ca9a
commit 16e7ad2923
5 changed files with 24 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/FAQ.org
View File

@ -190,9 +190,9 @@ mode:
*** 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=.
that your =$PATH= must contain the installation paths for those tools. For
example, if you have installed some tools to =~/.local/bin= and want them to be
available in Spacemacs, 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
@ -203,19 +203,19 @@ 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=
in =$XDG_CONFIG_HOME= or its 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=
Users of other shells should consult its 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.
So now, =~/.local/bin= should be available in your =$PATH=. You can verify this
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"
@ -226,13 +226,13 @@ 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
Note that having =~/.local.bin= in your =$PATH= also means 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
In that case you have the option of updating the value of =exec-path= in the
=dotspacemacs/user-config= function of your =.spacemacs= file.
#+BEGIN_SRC
#+BEGIN_SRC emacs-lisp
(add-to-list 'exec-path "~/.local/bin/")
#+END_SRC

9
layers/+lang/agda/README.org
View File

@ -9,7 +9,6 @@
- [[#key-bindings][Key bindings]]
* Description
This layer adds support for the [[http://wiki.portal.chalmers.se/agda/pmwiki.php][Agda]] programming language.
** Some features:
@ -19,9 +18,7 @@ This layer adds support for the [[http://wiki.portal.chalmers.se/agda/pmwiki.php
*This layer is in construction, it needs your contributions and bug reports.*
* Install
** Layer
To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp
@ -29,7 +26,6 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC
** Agda
Quick instructions to install Agda assuming you have cabal installed:
#+BEGIN_SRC sh
@ -37,11 +33,10 @@ Quick instructions to install Agda assuming you have cabal installed:
#+END_SRC
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~).
information about setting up =$PATH=, check out the corresponding section in the
FAQ (~SPC f e h $PATH RET~).
* Key bindings
The key bindings of this layer don't follow the Spacemacs conventions,
we opted to a simple transcription of stock Agda mode key bindings to
Spacemacs leader key.

4
layers/+lang/go/README.org
View File

@ -34,8 +34,8 @@ You will need =gocode= and =godef=:
#+END_SRC
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~).
setting up =$PATH=, check out the corresponding section in the FAQ (~SPC f e h
$PATH RET~).
For best results, make sure that the =auto-completion= and =syntax-checking=
layers are enabled as well.

18
layers/+lang/haskell/README.org
View File

@ -63,20 +63,19 @@ following command:
#+END_SRC
** Setup PATH
First of all make sure that your =$PATH= contains the installation path for
Haskell tools like =ghc=, =ghci= etc. It depends on how you have installed
=ghc=, but you can always check it by running =which ghc= in your terminal.
=Stack= users should add only the installation path of =stack= itself. Usually
it's =~/.local/bin=.
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
should add only installation path of =stack= itself, usually it's
=~/.local/bin=.
Then make sure that your =$PATH= contains installation path for =cabal=
Then make sure that your =$PATH= contains the installation path for =cabal=
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=.
For information about setting up =$PATH=, checkout corresponding section in FAQ
(~SPC f e h $PATH RET~).
For information about setting up =$PATH=, check out the corresponding section in
the FAQ (~SPC f e h $PATH RET~).
** OS X
Note that =emacs.app= for OS X does not pick up =$PATH= from =~/.bashrc= or
@ -264,7 +263,6 @@ This commands are available in a cabal file.
| ~SPC m f~ | find or create source-file under the cursor |
* FAQ
** REPL doesn't work
Usually =haskell-mode= is great at figuring out which interactive process to
bring up. But if you are experiencing problems with it you can help

7
layers/+tools/evernote/README.org
View File

@ -11,7 +11,6 @@
- [[#key-bindings][Key Bindings]]
* Description
This layer groups together packages to work with [[https://evernote.com/][Evernote]].
It uses the non official Evernote command line tool [[http://www.geeknote.me][geeknote]] which allows users
@ -22,9 +21,7 @@ default, =geeknote.el= doesn't have key bindings defined. This contribution
layer provides key bindings for all of geeknote.el's exposed features.
* Install
** Layer
To use this contribution add it to your =~/.spacemacs=
#+BEGIN_SRC emacs-lisp
@ -32,13 +29,11 @@ To use this contribution add it to your =~/.spacemacs=
#+END_SRC
** geeknote
The command =geeknote= is expected to be present in your =$PATH=. To
obtain this utility, please refer to the official geeknote
[[http://www.geeknote.me/documentation/][documentation]].
** geeknote.el
=geeknote.el= relies on having a correctly setup geeknote editor. To set
this up, run the following command in your terminal after successfully
installing =geeknote=:
@ -50,7 +45,7 @@ installing =geeknote=:
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~).
check out the corresponding section in the FAQ (~SPC f e h $PATH RET~).
* Key Bindings