README.md (1535B)
1 # eshell-port-helper 2 3 This package provides functions for working with OpenBSD ports tree in 4 eshell. 5 6 ## usage 7 8 Copy `eshell-port-helper.el` in your 9 `~/.emacs.d/elpa/eshell-port-helper` directory. Then, add to your 10 config: 11 12 ```elisp 13 (add-to-list 'load-path "~/.emacs.d/elpa/eshell-port-helper") 14 (require 'eshell-port-helper) 15 ``` 16 Eval and run `M-x port-jump-to-port`. 17 18 You can use `aliases` for short form of commands like this: 19 20 ```elisp 21 (defalias 'pdir 'eshell/port-jump-to-port-dir) 22 (defalias 'psrc 'eshell/port-jump-to-src-dir) 23 (defalias 'pjump 'eshell/port-jump) 24 (defalias 'ppatch 'eshell/port-patch) 25 (defalias 'punpatch 'eshell/port-unpatch) 26 (defalias 'pmake 'eshell/port-make) 27 (defalias 'pupdate 'eshell/port-update-patches) 28 ``` 29 30 ## variables 31 32 `port-dir` - base directory fir port tree 33 34 `port-ignore-port-dirs` - this directories will be ignore when we 35 search for ports 36 37 ## functions 38 39 `port-jump-to-port` - interactive function for open eshell in specific 40 port directory 41 42 `eshell/port-jump-to-port-dir port-name` - change directory to port base 43 directory 44 45 `eshell/port-jump-to-src-dir port-name` - change directory to port's source dir 46 47 `eshell/port-jump` - jump between port directory and source directory 48 49 `eshell/port-patch file` - make backup file with right suffix and open file 50 for editing 51 52 `eshell/port-unpatch file` - restore original port file from backup 53 54 `eshell/port-make command` - run make command in port directory 55 56 `eshell/port-update-patches` - update patches for current port and 57 open changed patches in emacs