From 6363c6cbf0fc1030b5fcb619086370d4112c8ed3 Mon Sep 17 00:00:00 2001 From: Simon Gomizelj Date: Fri, 2 Dec 2011 11:00:25 -0500 Subject: [PATCH] We should start documenting things. --- README.md | 3 ++- plugins/archlinux/README.md | 0 plugins/git/README.md | 0 plugins/keychain/README.md | 0 plugins/notfound/README.md | 0 plugins/tmux/README.md | 34 ++++++++++++++++++++++++++++++++++ plugins/tmux/tmux.plugin.zsh | 18 +++++++++++++++++- 7 files changed, 53 insertions(+), 2 deletions(-) create mode 100644 plugins/archlinux/README.md create mode 100644 plugins/git/README.md create mode 100644 plugins/keychain/README.md create mode 100644 plugins/notfound/README.md create mode 100644 plugins/tmux/README.md diff --git a/README.md b/README.md index 2db29c051..3c403b377 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,10 @@ $ chsh -s /bin/zsh Then the following needs to be added to `~/.zshrc` file to activate oh-my-zshell goodness. + autoload omz zstyle :omz:style theme arch-blue plugins=(archlinux sprunge git) - omz_init + omz init A skeleton template can be found at `/usr/share/oh-my-zsh/templates/user.zsh-template` diff --git a/plugins/archlinux/README.md b/plugins/archlinux/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/git/README.md b/plugins/git/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/keychain/README.md b/plugins/keychain/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/notfound/README.md b/plugins/notfound/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/plugins/tmux/README.md b/plugins/tmux/README.md new file mode 100644 index 000000000..6da3ef18c --- /dev/null +++ b/plugins/tmux/README.md @@ -0,0 +1,34 @@ +Tmux +==== + +DESCRIPTION TO GO HERE + +Configuration +------------- + +To set a corresponding command to a session name, set a zstyle like +this + + zstyle :omz:plugins:tmux:cmd irc weechat-curses + +This setups up the tmux plugin to start or jump to weechat when `t +irc` is executed. + +The plugin can be configured to start tmux with zsh. To do so, set +this zstyle appropriately. If so, it's ideal to have tmux first in the +plugin array + + zstyle :omz:plugins:tmux autostart on + +Usage +----- + +You can call the `t` function in two ways: + + t session + t session command + +Copyright & License +------------------- + +This plugin is released under the GLP3 diff --git a/plugins/tmux/tmux.plugin.zsh b/plugins/tmux/tmux.plugin.zsh index ce7e0d5b7..5e39f5792 100644 --- a/plugins/tmux/tmux.plugin.zsh +++ b/plugins/tmux/tmux.plugin.zsh @@ -1,9 +1,25 @@ +# tmux plugin +# Copyright (C) 2011 Simon Gomizelj +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# # Enable autostarting of tmux with: # zstyle :omz:plugins:tmux autostart on # # Configure t command to autostart a command like # this (example for "t irc"): -# zstyle :omz:plugins:cmd irc weechat-curses +# zstyle :omz:plugins:tmux:cmd irc weechat-curses # if (( $+commands[tmux] )); then