jimeh/tmuxifier
1
0
Fork 0
mirror of https://github.com/jimeh/tmuxifier.git synced 2026-02-19 09:56:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some documentation to layout helper functions

Browse Source
This commit is contained in:
Jim Myhrberg
2012-04-25 23:24:48 +01:00
parent f305cc31d7
commit 00a4f586b3
1 changed files with 25 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
layout-helpers.sh
View File

@@ -7,6 +7,11 @@
# #
# Create a new window. # Create a new window.
#
# Arguments:
# - $1: (optional) Name/title of window.
# - $2: (optional) Shell command to execute when window is created.
#
new_window() { new_window() {
if [ ! -z "$1" ]; then if [ ! -z "$1" ]; then
window="$1" window="$1"
@@ -21,6 +26,10 @@ new_window() {
} }
# Load specified window layout. # Load specified window layout.
#
# Arguments:
# - $1: Name of window layout to load.
#
load_window() { load_window() {
local file="$TMUXIFIER_LAYOUT_PATH/$1.window.sh" local file="$TMUXIFIER_LAYOUT_PATH/$1.window.sh"
if [ -f "$file" ]; then if [ -f "$file" ]; then
@@ -38,6 +47,10 @@ load_window() {
} }
# Load specified session layout. # Load specified session layout.
#
# Arguments:
# - $1: Name of session layout to load.
#
load_session() { load_session() {
local file="$TMUXIFIER_LAYOUT_PATH/$1.session.sh" local file="$TMUXIFIER_LAYOUT_PATH/$1.session.sh"
if [ -f "$file" ]; then if [ -f "$file" ]; then
@@ -55,6 +68,10 @@ load_session() {
} }
# Cusomize session root path. Default is `$HOME`. # Cusomize session root path. Default is `$HOME`.
#
# Arguments:
# - $1: Directory path to use for session root.
#
session_root() { session_root() {
local dir="$(__expand_path $@)" local dir="$(__expand_path $@)"
if [ -d "$dir" ]; then if [ -d "$dir" ]; then
@@ -63,6 +80,10 @@ session_root() {
} }
# Customize window root path. Default is `$session_root`. # Customize window root path. Default is `$session_root`.
#
# Arguments:
# - $1: Directory path to use for window root.
#
window_root() { window_root() {
local dir="$(__expand_path $@)" local dir="$(__expand_path $@)"
if [ -d "$dir" ]; then if [ -d "$dir" ]; then
@@ -72,6 +93,10 @@ window_root() {
# Create a new session, returning 0 on success, 1 on failure. # Create a new session, returning 0 on success, 1 on failure.
# #
# Arguments:
# - $1: (optional) Name of session to create, if not specified `$session`
# is used.
#
# Example usage: # Example usage:
# #
# if initialize_session; then # if initialize_session; then