.\" Text automatically generated by md2man 
.TH tmww-zsh 7 "October 16, 2014" "Linux" "Linux Reference Manual"
.SH NAME
\fBtmww \fP- zsh completion overview
.PP
.SH DESCRIPTION
Things being completed:
.IP \(bu 3
configs
.IP \(bu 3
plugins
.IP \(bu 3
online list charnames
.IP \(bu 3
player aliases from db
.IP \(bu 3
standart fields (string/array)
.IP \(bu 3
standart roles in roles field
.IP \(bu 3
full plugins synthax
.IP \(bu 3
scripts inside configs also can be completed
.PP
On zsh start central oh-my-zsh tmww plugin will include all files found in
default plugins path cut from system-wide tmww script executable. These files
define shortcut aliases like
.PP
.nf
.fam C
    alias ta="tmww arseoscope"
.fam T
.fi
.PP
List of all aliases displayed with:
.PP
.nf
.fam C
    $ tmww -z
.fam T
.fi
.PP
Next comment lines provide proper descriptions in completion:
.PP
file.plugin:
.IP \(bu 3
"# whatis: { description }" -- description in "tmww \fB-p\fP" or "tmww \fB-a\fP <tab>"
.PP
file.conf:
.IP \(bu 3
"# zshcompdesc: { plugin -> description }" -- description in "tmww <tab>"
.IP \(bu 3
"# zshcompoverride: { plugin }" -- plugin.zsh overriding action completion
for custom scripts in configs
.PP
Online charnames completion reloads each time you restart completion with tab.
.PP
Standart fields and roles for alts.plugin are duplicated multiple times, so one
should do some grep in order to reassign them.
.PP
Player aliases completion values are cached and regenerated each weak. As with
any zsh cached completion easiest way to force regeneration - delete old
completion cache. Try "${ZSH}/cache/TMWW_servername".
.PP
.SH INTEGRATION
.SS Manual instructions
Clone oh-my-zsh:
.PP
.nf
.fam C
    $ git clone --depth=1 https://github.com/robbyrussell/oh-my-zsh
    $ cp ~/.zshrc ~/.zshrc.orig
    $ cp ~/.oh-my-zsh/templates/zshrc.zsh-template ~/.zshrc
.fam T
.fi
.PP
Place tmww.plugin.zsh to ${ZSH}/custom/plugins/tmww/ .
Then include "tmww" to plugins array in ~/.zshrc; something like:
.PP
.nf
.fam C
    plugins=(git compleat debian tmww)
.fam T
.fi
.PP
And reload zsh session.
.PP
.SH EXAMPLE
See example_script.zsh in distribution or default inspect.conf and inspect.zsh.
.PP
.SH COPYRIGHT
This document is part of tmww - The Mana World Watcher scripts.
.PP
Licensed under terms of GNU General Public License version 3. For full text of
license see COPYING file distributed with tmww.
.PP
.SH AUTHORS
willee <v4r@trioptimum.com>, 2012-2014
.PP
.SH SEE ALSO
\fBtmww\fP(1), \fBtmww-config\fP(5)