We should start documenting things.

This commit is contained in:
Simon Gomizelj 2011-12-02 11:00:25 -05:00
commit 6363c6cbf0
7 changed files with 53 additions and 2 deletions

34
plugins/tmux/README.md Normal file
View file

@ -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

View file

@ -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 <http://www.gnu.org/licenses/>.
#
# 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