Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plandes/choice-program
Invoke Programs With Choice Options
https://github.com/plandes/choice-program
command-line emacs melpa
Last synced: about 2 months ago
JSON representation
Invoke Programs With Choice Options
- Host: GitHub
- URL: https://github.com/plandes/choice-program
- Owner: plandes
- License: gpl-2.0
- Created: 2016-12-24T22:38:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-05T16:42:25.000Z (about 1 year ago)
- Last Synced: 2024-04-25T01:34:40.978Z (5 months ago)
- Topics: command-line, emacs, melpa
- Language: Emacs Lisp
- Size: 84 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Invoke Programs With Choice Options
[![MELPA badge][melpa-badge]][melpa-link]
[![MELPA stable badge][melpa-stable-badge]][melpa-stable-link]
[![Build Status][build-badge]][build-link]
This is an Emacs module that invokes a command line program that requires an a
string of enumerations as input. An example is the mnemonic option of the
[synconf] program. The enumeration of choices offered by the command line
program are then read as a completing user input in Emacs.
## Usage
You must create an instance of the `choice-program` class and specify the program
with options. For the [synconf] program
you'd add the following to your `~/.emacs` init file:
```elisp
(defvar synconf-the-instance
(choice-program nil
:program "synconf"
:interpreter "perl"
:buffer-name "*Synchronized Output*"
:choice-prompt "Mnemonic"
:choice-switch-name "-m"
:selection-args '("-a" "listmnemonics")
:documentation
"Run a synchronize command. The command is issued with the `synconf'
perl script.")
"The synconf object instance.")
(choice-program-create-exec-function 'synconf-the-instance)
```
If you'd like add the configuration in another config file you can use add the
following:
```elisp
;;;###autoload
(defun synconf (&optional rest) (interactive))
(choice-program-create-exec-function 'synconf-the-instance)
```
This adds the configuration file to autoloads (pattern matching on the
interactive function `synconf`). Then the subsequent call to
`choice-program-create-exec-function` clobbers the empty interactive definition
with that which invokes the command line program.
## Changelog
An extensive changelog is available [here](CHANGELOG.md).
## License
Copyright © 2017 Paul Landes
GNU Lesser General Public License, Version 2.0
[melpa-link]: https://melpa.org/#/choice-program
[melpa-stable-link]: https://stable.melpa.org/#/choice-program
[melpa-badge]: https://melpa.org/packages/choice-program-badge.svg
[melpa-stable-badge]: https://stable.melpa.org/packages/choice-program-badge.svg
[build-badge]: https://github.com/plandes/choice-program/workflows/CI/badge.svg
[build-link]: https://github.com/plandes/choice-program/actions
[synconf]: https://github.com/plandes/synconf