# -*- coding: utf-8 -*-

"""This code is a part of Hydra Toolkit

.. module:: hydratk.translation.en.help
   :platform: Unix
   :synopsis: English language translation for help generator
.. moduleauthor:: Petr Czaderna <pc@hydratk.org>

"""

language = {
    'name': 'English',
    'ISO-639-1': 'en'
}

''' Hydra Native Commands '''

help_cmd = {
    'start': 'starts the application',
    'stop': 'stops the application',
    'help': 'prints help',
    'list-extensions': 'displays list of loaded extensions',
    'create-config-db': 'creates configuration database',
    'create-ext-skel': 'creates project skeleton for HydraTK extension development',
    'create-lib-skel': 'creates project skeleton for HydraTK library development'
}

help_cmd_args = {
    'help': '<command>'
}

''' Hydra Native Options '''
help_opt = {
    'debug': {'{h}-d, --debug <level>{e}': 'debug turned on with specified level > 0'},
    'debug-channel': {'{h}-e, --debug-channel <channel number, ..>{e}': 'debug channel filter turned on'},
    'config': {'{h}-c, --config <file>{e}': 'reads the alternate configuration file'},
    'force': {'{h}-f, --force{e}': 'enforces command'},
    'home': {'{h}-h, --home{e}': 'sets htk_root_dir to the current user home directory'},
    'interactive': {'{h}-i, --interactive{e}': 'turns on interactive mode'},
    'language': {'{h}-l, --language <language>{e}': 'sets the text output language, the list of available languages is specified in the docs'},
    'run-mode': {'{h}-m, --run-mode <mode>{e}': 'sets the running mode, the list of available modes is specified in the docs'},
    'profiler': {'{h}-p, --profiler <file>{e}': 'enables cProfiler and outputs the measuring to the specified file'},
    'pstats-sort-by': {'{h}--pstats-sort-by <key1,key2...>{e}': 'specifies sort-by key for profiler statistics output'},
    'pstats-strip-dirs': {'{h}--pstats-strip-dirs{e}': 'strips long directories out of the profiler statistics output'},
    'config-db-file': {'{h}--config-db-file <file>{e}':  {'description': 'optional, database file path', 'commands': ('create-config-db')}},
    'ext-skel-path': {'{h}--ext-skel-path <path>{e}': {'description': 'optional, directory path where HydraTK extension skeleton will be created', 'commands': ('create-ext-skel')}},
    'lib-skel-path': {'{h}--lib-skel-path <path>{e}': {'description': 'optional, directory path where HydraTK library skeleton will be created', 'commands': ('create-lib-skel')}}
}
