smith_help

#!/usr/bin/env python3
# Author: Kurt Irvin Rojas
# https://github.com/kimrojas/smith_utils
import sys

short_help = """
SMITH UTILITIES
    `smith_help`
        Description:
            Shows Basic Utility descriptions
        Usage:
            smith_help

    `smith_user_setup`
        Description:
            Creates a configuration file about ssh login details to smith
        Usage:
            smith_user_setup
            
    `smith_connect`
        Description:
            Initiates an ssh login to smith with smart switch between using a 
            local vs global ssh command, prioritizing local if both are avaialale.
            
            Note: Global ssh command requires a running `smith_tunnel` instance 
            in another window.
        Usage:
            smith_connect
            
    `smith_tunnel`
        Description:
            Creates a connection instance to Osaka University network thus creating
            a tunnel that allows connection to smith. A running instance of `smith_tunnel`
            is required for out-of-university logins.
        Usasge:
            smith_tunnel
            
    `smith_share`
        Description:
            Mounts the user's HOME DIRECTORY in smith to the local machine ($HOME/smith_server).
            This reduces the amount of lag experienced when using X11 forwarding from smith
            
            (i.e. xcrysden from smith forwards image, with smith_share smith only forwards the file
            but uses local machine's xcryden).
            
            The user also has the advantage of using personal environment 
            (i.e. local python environment or text editor usage for data processing)
        Usage: 
            smith_share [ mount | unmount ]
            
            
    `smith_kstat`
        Description:
            Sends a query command to smith about the status of the user's jobs. 
            COMMAND = 'qstat -u <username>'
        Usage:
            smith_kstat
    
    `smith_avail`
        Description:
            Sends a query command to smith check on available nodes.
        Usage:
            smith_avail
            
    `smith_qsub`
        Description:
            Sends a qsub command to smith with explicit login. Use in conjunction with smith_share.
        Usage:
            smith_qsub [qsub options]
"""

print(short_help)