Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kyagi/shell-pop-el
shell-pop.el helps you to use shell easily on Emacs. Only one key action to work.
https://github.com/kyagi/shell-pop-el
emacs guake shell terminal
Last synced: 3 months ago
JSON representation
shell-pop.el helps you to use shell easily on Emacs. Only one key action to work.
- Host: GitHub
- URL: https://github.com/kyagi/shell-pop-el
- Owner: kyagi
- Created: 2012-10-14T12:31:10.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2023-12-28T06:12:03.000Z (11 months ago)
- Last Synced: 2024-05-01T20:37:09.232Z (7 months ago)
- Topics: emacs, guake, shell, terminal
- Language: Emacs Lisp
- Homepage:
- Size: 308 KB
- Stars: 207
- Watchers: 10
- Forks: 21
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# shell-pop-el [![melpa badge][melpa-badge]][melpa-link] [![melpa stable badge][melpa-stable-badge]][melpa-stable-link]
shell-pop.el helps you to use shell easily on Emacs. Only one key action to work.
## Installation
You can install shell-pop.el from [MELPA](https://melpa.org/) and [Marmalade](https://marmalade-repo.org/)
with `package.el`.
```
M-x package-install shell-pop
```
### Manual Install
Make sure to place shell-pop.el somewhere in the load-path and add the following lines
to your init file(`~/.emacs.d/init.el`, `~/.emacs` etc).
```lisp
(add-to-list 'load-path "somewhere")
(require 'shell-pop)
```
## Customization
Use `M-x customize-variable RET shell-pop-shell-type RET` to customize the shell to use. Four pre-set options are: `shell`, `terminal`, `ansi-term`, and `eshell`. You can also set your custom shell if you use other configuration.
For `terminal` and `ansi-term` options, you can set the underlying shell by customizing `shell-pop-term-shell`. By default, `shell-file-name` is used, but you can also use `/bin/tcsh`, `/bin/zsh` or others.
Use `M-x customize-group RET shell-pop RET` to set further options such as hotkey, window height and position.
You can get a full frame layout by setting `full` to `shell-pop-window-position`.
After saving the customized values, your .emacs file will be like as follows.
```lisp
(custom-set-variables
;; custom-set-variables was added by Custom.
;; If you edit it by hand, you could mess it up, so be careful.
;; Your init file should contain only one such instance.
;; If there is more than one, they won't work right.
'(shell-pop-default-directory "/Users/kyagi/git")
'(shell-pop-shell-type (quote ("ansi-term" "*ansi-term*" (lambda nil (ansi-term shell-pop-term-shell)))))
'(shell-pop-term-shell "/bin/bash")
'(shell-pop-universal-key "C-t")
'(shell-pop-window-size 30)
'(shell-pop-full-span t)
'(shell-pop-window-position "bottom")
'(shell-pop-autocd-to-working-dir t)
'(shell-pop-restore-window-configuration t)
'(shell-pop-cleanup-buffer-at-process-exit t))
```
#### `shell-pop-window-position`(Default: "bottom")
Position of popup window. You can choose `"bottom"`, `"top"`, `"right"`, `"left"` and `"full"`.
Use entire frame when this value is `"full"`.
#### `shell-pop-window-size`(Default: `30`)
Percentage for shell-buffer window size.
#### `shell-pop-full-span`
This option allows you to generate the shell window with the same width as the current Emacs frame. It is beneficial when you are always using multiple windows on Emacs. In detail, see https://github.com/kyagi/shell-pop-el/pull/21#issuecomment-48876673
#### `shell-pop-in-hook`
This hook runs before shell buffer pop-up.
#### `shell-pop-in-after-hook`
This hook runs after shell buffer pop-up.
#### `shell-pop-out-hook`
This hook runs before shell buffer pop-out.
#### `shell-pop-process-exit-hook`
This hook runs when the shell's process exits.
## Usage
Just hit the hot key you customized for `shell-pop-universal-key`.
For example, `C-t` for the above case.
You can have multiple shell buffers if you run shell-pop with universal-arguments.
For example, `C-u 2 C-t`. You can increase the number(`2`, `3`, `4`, ...) as much as you want for different shell buffers.
## Screenshot
## EmacsWiki (No longer updated)
http://www.emacswiki.org/emacs/ShellPop
[melpa-link]: http://melpa.org/#/shell-pop
[melpa-stable-link]: http://stable.melpa.org/#/shell-pop
[melpa-badge]: http://melpa.org/packages/shell-pop-badge.svg
[melpa-stable-badge]: http://stable.melpa.org/packages/shell-pop-badge.svg