mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2025-12-26 02:12:33 +01:00
Updated documentation.
This commit is contained in:
parent
f8bace703a
commit
69c6c04f64
3 changed files with 28 additions and 69 deletions
|
|
@ -22,10 +22,6 @@ install it:
|
||||||
$ cower -dd oh-my-zsh-git
|
$ cower -dd oh-my-zsh-git
|
||||||
```
|
```
|
||||||
|
|
||||||
[zsh]: http://www.zsh.org/
|
|
||||||
[oh-my-zsh-git]: https://aur.archlinux.org/packages.php?ID=54375
|
|
||||||
[cower]: https://github.com/falconindy/cower
|
|
||||||
|
|
||||||
The user must have zsh set as their shell.
|
The user must have zsh set as their shell.
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
@ -65,4 +61,7 @@ Resources
|
||||||
|
|
||||||
The [refcard][] is pretty tasty for tips.
|
The [refcard][] is pretty tasty for tips.
|
||||||
|
|
||||||
|
[zsh]: http://www.zsh.org/
|
||||||
|
[oh-my-zsh-git]: https://aur.archlinux.org/packages.php?ID=54375
|
||||||
|
[cower]: https://github.com/falconindy/cower
|
||||||
[refcard]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
|
[refcard]: http://www.bash2zsh.com/zsh_refcard/refcard.pdf
|
||||||
|
|
|
||||||
|
|
@ -1,39 +1,25 @@
|
||||||
# sprunge alias
|
Sprunge
|
||||||
|
=======
|
||||||
|
|
||||||
This plugin adds at least an alias to zsh. However, you can use the smarter
|
This plugin adds powerful sprunge functionality to zsh. The script
|
||||||
script, provided as part of the plugin, instead. To enable it, add the following
|
optionally requires pygments with python >= 2.7 and either xclip or
|
||||||
to your `.zshrc`:
|
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
|
You can call `sprunge` in any of the following ways:
|
||||||
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.
|
|
||||||
|
|
||||||
# Note
|
sprunge [files]
|
||||||
|
sprunge < file
|
||||||
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**.
|
|
||||||
|
|
||||||
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
|
piped_data | sprunge
|
||||||
|
|
||||||
Otherwise, the alias defined by the script can only be called the following way:
|
Copyright & License
|
||||||
|
-------------------
|
||||||
|
|
||||||
piped_data | sprunge
|
This plugin is released under the MIT license. The script is presumed
|
||||||
|
to be released into the public domain, as the original announcement
|
||||||
# Copyright & License
|
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.
|
|
||||||
|
|
|
||||||
|
|
@ -11,39 +11,13 @@ DESCRIPTION
|
||||||
Upload data and fetch URL from the pastebin http://sprunge.us
|
Upload data and fetch URL from the pastebin http://sprunge.us
|
||||||
|
|
||||||
In addition to printing the returned URL, if the xset or xsel
|
In addition to printing the returned URL, if the xset or xsel
|
||||||
programs are available (on $PATH), the URL will also be copied to the
|
programs are available, the URL will also be copied to the
|
||||||
PRIMARY selection and the CLIPBOARD selection (allowing to quickly
|
PRIMARY selection and the CLIPBOARD selection.
|
||||||
paste the url into IRC client for example).
|
|
||||||
|
|
||||||
USAGE
|
USAGE
|
||||||
$0 filename.txt
|
sprunge [files]
|
||||||
$0 < filename.txt
|
sprunge < file
|
||||||
piped_data | $0
|
piped_data | sprunge
|
||||||
|
|
||||||
INPUT METHODS
|
|
||||||
$0 can accept piped data, STDIN redirection [<filename.txt], text strings
|
|
||||||
following the command as arguments, or filenames as arguments. Only one
|
|
||||||
of these methods can be used at a time, so please see the note on
|
|
||||||
precedence. Also, note that using a pipe or STDIN redirection will treat
|
|
||||||
tabs as spaces, or disregard them entirely (if they appear at the
|
|
||||||
beginning of a line). So I suggest using a filename as an argument if
|
|
||||||
tabs are important either to the function or readability of the code.
|
|
||||||
|
|
||||||
PRECEDENCE
|
|
||||||
STDIN redirection has precedence, then piped input, then a filename as an
|
|
||||||
argument. Example:
|
|
||||||
|
|
||||||
echo piped | "$0" arguments.txt < stdin_redirection.txt
|
|
||||||
|
|
||||||
In this example, the contents of file_as_stdin_redirection.txt would be
|
|
||||||
uploaded. Both the piped_text and the file_as_argument.txt are ignored. If
|
|
||||||
there is piped input and arguments, the arguments will be ignored, and the
|
|
||||||
piped input uploaded.
|
|
||||||
|
|
||||||
FILENAMES
|
|
||||||
If a filename is misspelled or doesn't have the necessary path
|
|
||||||
description, it will NOT generate an error, but will instead treat it as
|
|
||||||
a text string and upload it.
|
|
||||||
|
|
||||||
HERE
|
HERE
|
||||||
}
|
}
|
||||||
|
|
@ -95,7 +69,7 @@ sprunge() {
|
||||||
# don't copy to clipboad if piped
|
# don't copy to clipboad if piped
|
||||||
[[ ! -t 1 ]] && return 0
|
[[ ! -t 1 ]] && return 0
|
||||||
|
|
||||||
#copy url to primary and clipboard (middle-mouse & shift+ins/Ctrl+v)
|
# copy urls to primary and clipboard (middle-mouse & shift+ins/Ctrl+v)
|
||||||
if (( $+commands[xclip] )); then
|
if (( $+commands[xclip] )); then
|
||||||
echo -n $urls | xclip -sel primary
|
echo -n $urls | xclip -sel primary
|
||||||
echo -n $urls | xclip -sel clipboard
|
echo -n $urls | xclip -sel clipboard
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue