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

NAME

App::VTide::Configuration - Description of the vtide configuration files

VERSION

This documentation refers to App::VTide::Configuration version 0.1.10

SYNOPSIS

   # .vtide.yml
   ---
   name: project
   # terminal count
   count: 4
   default:
     restart: 0
     wait: 1
   editor:
   terminals:
     2:
       # override defaults
       restart: 1
       wait: 0
       # run a command
       command: ./Build

DESCRIPTION

The default configuration file ~/.vtide/default.yml and the project specific configuration file ./.vtide.yml both have the same format.

CONFIGURATION ITEMS

name

String

The name of the project (projects only)

count

Integer

The number of tmux windows to start

default

Hash

Default options for terminals. The following is a description of each of it's keys.

env

Hash

A list of environment variables to set for terminals. You use other environment variables in the values (e.g. say setting the path you could use bin:$PATH) but no other expansions are done.

restart

Bool

If set to a true value the an option to restart will be given

title

String

This is the text of the terminal title if you want it to be different from the name field.

wait

Don't instantly start the command/editor wait till enter is pressed.

split

String

Tells how to split a tmux window into separate panes

e.g.

 Hv (cursor ends up in 1a)
    +--+--+
    |1 |1a|
    |  +--+
    |  |1b|
    +--+--+

  Hv0 (cursor ends up in 1)
    +--+--+
    |1 |1a|
    |  +--+
    |  |1b|
    +--+--+

watch

List

Specifies a list of files to watch for changes. When found the command is rerun.

command

String or List

A command to be run in the terminal

edit

String or List

A list of files or file groups to run the editor with. If this is specified the command attribute is ignored.

heading

This is text to be displayed just before running the terminal. It can be used for example to remind of the intended purpose of the terminal.

editor

Hash

Default options for the editor

terminals

Hash

Details about each tmux terminal window, these details override what is set in defaults.

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.