The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
App-VTide-v1.0.5
River stage zero No dependents
1 ++
/ App::VTide::Command::Start

NAME

App::VTide::Command::Start - Start a session

VERSION

This documentation refers to App::VTide::Command::Start version 1.0.5

SYNOPSIS

    vtide start
    vtide start name [[-w|--window] num]
    vtide start [--help|--man]

  OPTIONS:
    name
                    The project to start (If not specified the current
                    directory is used to find a .vtide.yml file to start)

    -a --add-to-session
                    Save to sessions
    -w --windows[=]int
                    Use a different number of windows from the configured
                    number (i.e. as set is .vtide.yml)
    -T --test       Test a config (show the tmux command)
    -v --verbose    Show more details out put (passed on to run as well)
       --help       Show this help
       --man        Show full documentation

DESCRIPTION

Starts up an existing VTide project, either by name for by using the configuration in the current directory.

SUBROUTINES/METHODS

run ()

Starts the tmux session running a vtide run command in each terminal

ctags ()

Runs the ctags command if the config option ctags in the start group is set

tmux ( $name )

Run a tmux session with the name $name

tmux_window ( $name )

Creates the tmux configuration for a new window.

auto_complete ()

Auto completes session names

details_sub ()

Returns the commands details.

HOOKS

start_pre ( $name, $dir )

This is run just before the tmux session is started, the $name and the directory ($dir) of the project are passed.

DIAGNOSTICS

CONFIGURATION AND ENVIRONMENT

DEPENDENCIES

INCOMPATIBILITIES

BUGS AND LIMITATIONS

There are no known bugs in this module.

Please report problems to Ivan Wills (ivan.wills@gmail.com).

Patches are welcome.

AUTHOR

Ivan Wills - (ivan.wills@gmail.com)

LICENSE AND COPYRIGHT

Copyright (c) 2016 Ivan Wills (14 Mullion Close, Hornsby Heights, NSW Australia 2077). All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic. 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.

 =cut