https://github.com/pythonnut/su.el
Automatically read and write files using su or sudo
https://github.com/pythonnut/su.el
Last synced: about 1 month ago
JSON representation
Automatically read and write files using su or sudo
- Host: GitHub
- URL: https://github.com/pythonnut/su.el
- Owner: PythonNut
- License: mit
- Created: 2018-08-14T00:33:36.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-20T17:07:36.000Z (about 1 year ago)
- Last Synced: 2025-02-07T08:48:59.614Z (3 months ago)
- Language: Emacs Lisp
- Homepage:
- Size: 49.8 KB
- Stars: 17
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# `su.el`
[](https://melpa.org/#/su)
This package facilitates automatic privilege escalation for file permissions using TRAMP.
You can install the package by either cloning it yourself, or by doing M-x `package-install` RET `su` RET.
After that, you can enable it by putting the following in your init file:
```emacs
(su-mode +1)
# If you desire integration with helm
(with-eval-after-load 'helm-files
(su-helm-integration-mode +1))
# If you desire integration with semantic
(with-eval-after-load 'semantic/fw
(su-semantic-integration-mode +1))
```
When `su-mode` is enabled, files you do not have permission to read but not write will remain editable (i.e. `buffer-read-only` will be `nil`) and `su-mode` will indicate in the modeline that any changes made will require privilege escalation to save.
If you attempt to save your modifications, `su-mode` switches the path the buffer is visiting to a TRAMP path to the same file specifying a user able to perform the write.
If a password is required, TRAMP will ask you to enter it, after which the file will be written.
The visitation switch is permanent so you will remain authenticated thereafter.
If you do not even have permission to read the file, then `su.el` will switch the visited path immediately, allowing you to read it.
Significant effort has been made to ensure that `su.el` operates correctly.
In particular:
1. It can use either the `su` or `sudo` methods to switch users and will automatically detect which one to use.
2. It works even if you are already using TRAMP (e.g. for editing a remote file) by adding another hop.
3. It may even work with your custom TRAMP methods, although this cannot be guaranteed.