Watch - Command Line Interface documentation

Command Line Interface Watch (general presentation)

Watch is composed of the following menus:
  • Watch (main menu) Main menu
  • Tasks Task definition menu
  • Imputations Imputations menu definition
  • Revisions Task revision menu

    Menu Watch (main menu)

    Watch is composed of the following commands:
  • # [...] Insert a comment
  • show version Display Watch version
  • show copyright Display Watch license
  • xml-load <xml-path> Load an XML file
  • project <name> Project name setting
  • locale (...) Change locale settings
  • tasks Task definition menu
  • imputations <user-id> Imputations menu definition
  • revisions [...] Task revision menu
  • watch [...] (...) Watch project

    # [...]

    Synopsis:
    # [<word>]*

    Description:
    Insert a comment

    Options:
    <word> Word of comment

    Parameters:
    word (string) Word of comment

    show version

    Synopsis:
    show version

    Description:
    Display Watch version

    show copyright

    Synopsis:
    show copyright

    Description:
    Display Watch license

    xml-load <xml-path>

    Synopsis:
    xml-load <xml-path>

    Description:
    Load an XML file

    Parameters:
    xml-path (string) XML file path

    project <name>

    Synopsis:
    project <name>

    Description:
    Project name setting

    Parameters:
    name (string) Project name

    locale (...)

    Synopsis:
    locale (chinese | english | french | german | italian | japanese)

    Description:
    Change locale settings

    Options:
    chinese Chinese locale settings
    english English locale settings
    french French locale settings
    german German locale settings
    italian Italian locale settings
    japanese Japanese locale settings

    tasks

    Synopsis:
    tasks

    Description:
    Task definition menu

    This command opens the menu Tasks.

    imputations <user-id>

    Synopsis:
    imputations <user-id>

    Description:
    Imputations menu definition

    Parameters:
    user-id (string) User identifier

    This command opens the menu Imputations.

    revisions [...]

    Synopsis:
    revisions [date <date>]

    Description:
    Task revision menu

    Options:
    date <date> Task revision date

    Parameters:
    date (string) Task revision date

    This command opens the menu Revisions.

    watch [...] (...)

    Synopsis:
    watch [--sum] [--history] [--log] [--task <task-id>] [--user <user-id>]* [--from <from-date>] [--to <to-date>] [--until-today] [--current <current-date>] [--reference <ref-date>] [--xml] [--short] [--txt] [--html] [--xsl <xsl-path>] (--stdout | --out <out-path>)

    Description:
    Watch project

    Options:
    --sum Sum imputations only, do not check against the reference
    --history Compute history
    --log Display log option
    --task <task-id> Task focus option
    --user <user-id> User focus option (may be repeated for several users)
    --from <from-date> From date option
    --to <to-date> End date option
    --until-today Today end date option
    --current <current-date> Current date setting (default is today)
    --reference <ref-date> Reference date option
    --xml Display an XML result
    --short Display result as a short summary
    --txt Display a text result
    --html Display the HTML result
    --xsl <xsl-path> Apply an XSL transormation to XML result
    --stdout Standard output
    --out <out-path> Output file name

    Parameters:
    task-id (string) Task to focus on
    user-id (string) User to focus on
    from-date (string) From date
    to-date (string) End date
    current-date (string) Current date
    ref-date (string) Reference date
    xsl-path (string) XSL stylesheet
    out-path (string) Output file name

    Menu Tasks

    Tasks is composed of the following commands:
  • # [...] Insert a comment
  • xml-load <xml-path> Load an XML file
  • tasks Task definition menu
  • begin <task-id> [...] Start group task definition
  • end End group task definition
  • task <task-id> [...] Single task definition

    # [...]

    Synopsis:
    # [<word>]*

    Description:
    Insert a comment

    Options:
    <word> Word of comment

    Parameters:
    word (string) Word of comment

    xml-load <xml-path>

    Synopsis:
    xml-load <xml-path>

    Description:
    Load an XML file

    Parameters:
    xml-path (string) XML file path

    tasks

    Synopsis:
    tasks

    Description:
    Task definition menu

    This command opens the menu Tasks.

    begin <task-id> [...]

    Synopsis:
    begin <task-id> [start-date <start-date>]

    Description:
    Start group task definition

    Options:
    start-date <start-date> Start date

    Parameters:
    task-id (string) Task identifier
    start-date (string) Start date

    end

    Synopsis:
    end

    Description:
    End group task definition

    task <task-id> [...]

    Synopsis:
    task <task-id> [start-date <start-date>] [time <time>] [value <value>] [risks <risks>] [opportunities <opps>] [plan start <plan-start-date> end <plan-end-date> (evm at-end | evm linear | )]

    Description:
    Single task definition

    Options:
    start-date <start-date> Start date
    time <time> Estimated time for this task
    value <value> Estimated value for this task
    risks <risks> Initial risks
    opportunities <opps> Initial opportunities
    evm at-end At-end Earn-Value scheduling
    evm linear Linear Earn-Value scheduling
    plan start <plan-start-date> end <plan-end-date> Earn-value scheduling

    Parameters:
    task-id (string) Task identifier
    start-date (string) Start date
    time (float) Estimated time for this task
    value (float) Estimated value for this task
    risks (float) Initial risk value
    opps (float) Initial opportunities value
    plan-start-date (string) Planned start date
    plan-end-date (string) Planned end date
    plan-start-date (string) Planned start date
    plan-end-date (string) Planned end date

    Menu Imputations

    Imputations is composed of the following commands:
  • # [...] Insert a comment
  • imputation <task-id> date <date> (...) Imputation declaration

    # [...]

    Synopsis:
    # [<word>]*

    Description:
    Insert a comment

    Options:
    <word> Word of comment

    Parameters:
    word (string) Word of comment

    imputation <task-id> date <date> (...)

    Synopsis:
    imputation <task-id> date <date> (time <time> | value <value>)

    Description:
    Imputation declaration

    Options:
    time <time> Imputation time
    value <value> Imputation value

    Parameters:
    task-id (string) Task identifier
    date (string) Imputation date
    time (float) Imputation time
    value (float) Imputation value

    Menu Revisions

    Revisions is composed of the following commands:
  • # [...] Insert a comment
  • revision <task-id> [...] Task revision
  • lock <task-id> [...] Task lock

    # [...]

    Synopsis:
    # [<word>]*

    Description:
    Insert a comment

    Options:
    <word> Word of comment

    Parameters:
    word (string) Word of comment

    revision <task-id> [...]

    Synopsis:
    revision <task-id> [date <date>] [time <time>] [value <value>] [risks <risks>] [opportunities <opps>] [earned <earned>]

    Description:
    Task revision

    Options:
    date <date> Task revision date
    time <time> Remaining time revision
    value <value> Remaining value
    risks <risks> Risks revision
    opportunities <opps> Opportunities revision
    earned <earned> Earned value revision

    Parameters:
    task-id (string) Task identifier
    date (string) Task revision date
    time (float) Remaining time revision
    value (float) Remaining value revision
    risks (float) Risks revision
    opps (float) Opportunities revision
    earned (float) Earned value revision

    lock <task-id> [...]

    Synopsis:
    lock <task-id> [date <date>]

    Description:
    Task lock

    Options:
    date <date> Lock date

    Parameters:
    task-id (string) Task identifier
    date (string) Lock date

    File auto-generated by 'cli2help.xsl' - CLI library (Alexis Royer, http://alexis.royer.free.fr/CLI/).