#
#     _ _____ .___ __ _______ __ ______ _____ .___ __ ____ _ _______ _ _ 
#         ____|   \ _/   _   \ _/  __  \ _____|   \ _/___/__/   _   \_ _ 
#     _ _/    \    \\_   |____\\_  :/   \\_   \    \\_     /____|   _/// 
#     \\\_    /     |______    |   /____//   __\   |       |   ______|   
#       _    /|     _    :/    _         _   \:    _       _   \:    _ d
#     _ /    \:     \_   /     \_        \_   \    \_      \_   \    \ _ 
#     \\\      _____//_________//________//________//______//__      /// 
#     - -\____/------------------------------------------------\____/- - 
#
#     -- useDIZ v1.10 by dMG/t!s 20090426 - asciiscene[-AT-]gmail.com --
#
# Format of help file:
# --------------------
#
# @tag
#
# <body>
#
# @end
# @tag...
#
# --------------------
# 
# where @tag is the name of the user argument to accept. Have in mind that
# the script recognizes @tag ONLY if the line starts with a @. This
# means that you are free to use the character in the <body>, would
# you so wish.
#
# useDIZ currently only accepts alphabetical input (a-z A-Z). Email me if you
# want this changed and can't handle regexp + edit the help / help_msg procs
# yourself.
#
# If no argument or a non existing one is sent to the script, it will always
# default to the first @tag. This makes it a good place to keep an index
# over your arguments.
#
# You can fake an empty line with with a space.
#

@help
Usage
=====
 
!help register                   - help with registering account, identify or op.
!help partyline                  - help with how to access the partyline.
!help filesys                    - help with the filesystem commands.
!help misc                       - help with miscellaneous commands.
 
@end
@register
Register account, identify and op
=================================
 
/msg hosee2 new                  - register as new user on hosee2.
/msg hosee2 pass <new password>  - register your password (required!).
/msg hosee2 op <password>        - make hosee2 give you op on channel.
/msg hosee2 ident <password>     - identify yourself to hosee2. use this
                                   whenever hosee2 won't accnowledge your
                                   commands.
@end
@partyline
Partyline
=========
 
/dcc chat hosee2                 - enter partyline!
/ctcp hosee2 chat                - enter partyline!
.help                            - while on partyline, print help.
.help <command> [switch]         - while on partyline, print help about
                                   specific command.
@end
@filesys
Filesystem
==========
 
/dcc send hosee2 <file(s)>       - send file to hosee2.
/dcc get hosee2                  - get file from hosee2. you will need to
                                   queue files for this. see below.
 
To enter filesystem you will need to be on the partyline first.
---------------------------------------------------------------
 
.files                           - enter filesystem to get access to the
                                   following commands:
cancel <file(s)>                 - tells hosee2 to stop sending pending
                                   files (queued, waiting or in transfer).
cd <directory>                   - change directory.
cp <source> <dest>               - copy a file or a group of files.
desc <file> [description]        - changes description of a file.
                                   masters and janitors can change all
                                   descriptions while users can change
                                   only their own uploaded files.
diz <filename>                   - show file_id.diz from ascii when in filesys.
filestats <user>                 - show user upload and download statistics,
get <filename(s)> [nick]         - sends requested files over dcc. you should
                                   get a DCC SEND notice and let your client
                                   accept it (/dcc get <filename>). if your
                                   nickname is different on irc than the one
                                   you use on the bot, you should specify
                                   the nickname too. you can also use that to
                                   send files to other people. hosee2 has a
                                   send limit of two files per user at once.
                                   all excess files are put in queue and will
                                   be sent when the first file has been
                                   finished.
help                             - displays a list of available DCC commands
                                   and a brief description of each.
help <command>                   - displays help on the specified file system
                                   command.
hide <file(s)>                   - marks files as hidden. only masters or
                                   file janitors using lsa can see hidden
                                   files.
ls [filemask]                    - displays the files in the current
                                   directory. subdirectories are shown with
                                   <DIR> next to them and other files will
                                   display their size (typically in kb) and
                                   other info.
lsa [filemask]                   - as ls but also lists hidden files. hidden
                                   files are marked (hid) and shared files
                                   are marked with (shr).
mkdir <dir> [flags [channel]]    - creates a subdirectory from current one.
                                   when flags are used the user needs the
                                   specified flags to enter or even see the
                                   directory. you can even specify a
                                   channel that the flags are matched
                                   against. you can use the mkdir command
                                   again to alter or remove those flags. 
mv <source> <dest>               - moves a file or a group of files. is
                                   also used to rename files.
optimise                         - cleans up current directory database.
                                   used to speed up slow/large
                                   directories.
pending                          - gives you a list of every file you've
                                   requested that are queued, waiting or
                                   in transfer. it shows the nick of
                                   person files are being transfered to
                                   and how far along the transfer is.
pwd                              - show current directory name.
quit                             - exit filesystem.
rm <file(s)>                     - erase files.
rmdir <dir>                      - removes an empty directory.
search <filename>                - find path of filename
stats                            - show user upload and download statistics.
unhide <file(s)>                 - unhide hidden files.
 
@end
@misc
Misc commands
=============
 
!seen <nick>                     - ask in channel if hosee2 has seen <nick>
/msg hosee2 seen <nick>          - ask in privmsg if hosee2 has seen <nick>
!diz <filename>                  - show file_id.diz from textfile
/msg hosee2 !diz <filename>      - show file_id.diz from textfile in privmsg.
!search <filename>               - find path of filename without displaying diz
/msg hosee2 !search <filename>   - find path of filename without displaying diz
                                 - in privmsg.
!get hosee2 [[path] <filename]   - get file without having to log in
                                   to filesystem. requires a password set.
!stats                           - file system statistics.
 
@end
