linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2025-12-26 02:12:33 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated documentation.

Browse source
This commit is contained in:
Simon Gomizelj 2011-11-29 12:25:39 -05:00
commit 69c6c04f64
3 changed files with 28 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

52
plugins/sprunge/README.md
View file

@ -1,39 +1,25 @@
# sprunge alias
Sprunge
=======
This plugin adds at least an alias to zsh. However, you can use the smarter
script, provided as part of the plugin, instead. To enable it, add the following
to your `.zshrc`:
This plugin adds powerful sprunge functionality to zsh. The script
optionally requires pygments with python >= 2.7 and either xclip or
xsel. Pygments is used to detect what language you have uploaded. If
it is detected, the url will automatically append the url with an
appropriate with `?lang`. Xclip or xsel are used to copy the urls to
the primary and secondary clipboards.
zstyle :omz:plugins:sprunge add-path on
Usage
-----
The plugin will modify your path, adding `$ZSH/plugins/sprunge` to the end of
it. This plugin presumes you set `$ZSH` to the directory where oh-my-zsh is
installed to. This is the default if you used the template zshrc.
You can call `sprunge` in any of the following ways:
# Note
sprunge [files]
sprunge < file
piped_data | sprunge
The plugin does not overwrite anything. If you had an alias, or there is another
binary in your system that is called 'sprunge', this plugin will do **nothing**.
Copyright & License
-------------------
The script also depends on pygments, and python >= 2.7. Pygments is used to
detect what language you have uploaded. If it is detected, the url will
automatically be appended with `?lang`, where 'lang' is language.
## Usage
If you let the plugin add the sprunge script to your $PATH, you can call
`sprunge` in any of the following ways:
sprunge filename.txt
sprunge < filename.txt
piped_data | sprunge
Otherwise, the alias defined by the script can only be called the following way:
piped_data | sprunge
# Copyright & License
This plugin is released under the MIT license. The script is presumed to be
released into the public domain, as the original announcement had no explicit
announcement.
This plugin is released under the MIT license. The script is presumed
to be released into the public domain, as the original announcement
had no explicit announcement.