view release on metacpan or  search on metacpan

lib/App/VTide/Command/Start.pm  view on Meta::CPAN

    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

=head1 DESCRIPTION

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

=head1 SUBROUTINES/METHODS

=head2 C<run ()>

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

=head2 C<ctags ()>

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

=head2 C<tmux ( $name )>

Run a tmux session with the name C<$name>

=head2 C<tmux_window ( $name )>

Creates the C<tmux> configuration for a new window.

=head2 C<auto_complete ()>

Auto completes session names

=head2 C<details_sub ()>

Returns the commands details.

=head1 HOOKS

=head2 C<start_pre ( $name, $dir )>

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

=head1 DIAGNOSTICS

=head1 CONFIGURATION AND ENVIRONMENT

=head1 DEPENDENCIES

=head1 INCOMPATIBILITIES

=head1 BUGS AND LIMITATIONS

There are no known bugs in this module.

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

Patches are welcome.

=head1 AUTHOR

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

=head1 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 L<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