Usage.txt

Usage: hourglass.exe [COMMAND] [OPTIONS] [<input>]

A simple countdown timer for Windows.

  <input>
        The input used to start the timer.

        For example:
        "5"                     count down for 5 minutes
        "5:30"                  count down for 5 minutes 30 seconds
        "7:30:00"               count down for 7 hours 30 minutes
        "5 minutes"             count down for 5 minutes
        "5 minutes 30 seconds"  count down for 5 minutes 30 seconds
        "7 hours 30 minutes"    count down for 7 hours 30 minutes
        "01/01/20"*             count down until January 1, 2020
        "01/01/2020"*           count down until January 1, 2020
        "January 1, 2020"*      count down until January 1, 2020
        "January 1"*            count down until January 1
        "2 pm"                  count down until 2 pm
        "2:30 pm"               count down until 2:30 pm
        "noon"                  count down until noon
        "midnight"              count down until midnight
        "Friday"                count down until midnight Friday

        * The order of the day, month, and year depends on your system settings.

        Variations of some of these formats are also supported.

Commands:

  pause
        Pauses all the running timers.

  resume
        Resumes all the paused timers.

Options:

  --title <title>
        Sets the title for the timer.

        Required        no
        Default value   (none)
        Alias           -t, /t

  --always-on-top on|off|last
        Displays the timer window on top of other windows.

        Required        no
        Default value   last
        Alias           -a, /a

  --full-screen on|off|last
        Displays the timer window in full-screen mode.

        Required        no
        Default value   last
        Alias           -f, /f

  --prompt-on-close on|off|last
        Displays a prompt before closing the timer window.

        Required        no
        Default value   last
        Alias           -o, /o

  --show-progress-in-taskbar on|off|last
        Shows progress in taskbar.

        Required        no
        Default value   last
        Alias           -y, /y

  --do-not-keep-awake on|off|last
        Do not keep the computer awake while the timer is running.

        Required        no
        Default value   last
        Alias           -k, /k

  --show-in-notification-area on|off|last
        Shows an icon for the app in the notification area.

        Required        no
        Default value   last
        Alias           -n, /n

  --reverse-progress-bar on|off|last
        Reverses the direction of the progress bar, causing it to run backwards.

        Required        no
        Default value   last
        Alias           -g, /g

  --activate-next on|off|last
        Activates the next window when the current one minimized or closed.

        Required        no
        Default value   last
        Alias           -an, /an

  --digital-clock-time on|off|last
        Displays time in the digital clock format:
        - d.hh:mm:ss if a time is longer than a day;
        -   hh:mm:ss otherwise.

        Required        no
        Default value   last
        Alias           -c, /c

  --show-time-elapsed on|off|last
        Shows the time elapsed since the timer was started, rather than the
        time left until the timer expires.

        Required        no
        Default value   last
        Alias           -u, /u

  --show-trigger-time on|off|last
        Shows the trigger time in the timer window and in the notification
        area context menu.

        Required        no
        Default value   last
        Alias           -st, /st

  --multi-timers on|off
        Treats each <input> command-line argument as an individual timer.

        An each timer containing spaces must be surrounded by double quotes.

        This option is never remembered. It must be specified as a command-line
        argument each time the timer is started.

        Required        no
        Default value   off
        Alias           -mt, /mt

  --loop-timer on|off|last
        Loops the timer when it expires.

        Required        no
        Default value   last
        Alias           -l, /l

  --pause-after-loop-timer on|off|last
        Pauses the loop timer when it expires.

        Required        no
        Default value   last
        Alias           -pl, /pl

  --pop-up-when-expired on|off|last
        Pops up the timer window when the timer expires.

        Required        no
        Default value   last
        Alias           -p, /p

  --close-when-expired on|off|last
        Closes the timer window when the timer expires.

        Required        no
        Default value   last
        Alias           -e, /e

  --shut-down-when-expired on|off
        Shuts down windows when the timer expires.

        Required        no
        Default value   off
        Alias           -x, /x

  --theme last|<theme>
        Sets the theme of the timer window.

        You can specify the name of one of the built-in themes, or the name of
        one of the themes that you have defined yourself.

        The built-in themes are:

            accent          accent-dark
            red             red-dark
            orange          orange-dark
            yellow          yellow-dark
            green           green-dark
            blue            blue-dark
            purple          purple-dark
            gray            gray-dark
            black           black-dark

        Required        no
        Default value   last
        Alias           -m, /m

  --sound none|last|<sound>
        Plays a sound when the timer expires.

        Required        no
        Default value   last
        Alias           -s, /s

        <sound> is the name of a sound file without extension. The sound file
        should be placed to the application directory or to the
        "%LOCALAPPDATA%\Hourglass" directory or to the "Sounds" subdirectory,
        while no Hourgrass is being run. It can be the symbolic link created
        by the "mklink" system command.

        The sound file supported extensions are:

            .aac
            .m4a
            .mid
            .midi
            .mp3
            .wav
            .wma

        If NAudioHourglassPack is used for playing a sound (see FAQ), the sound
        file supported extensions are:

            .aiff
            .mp3
            .wav

  --loop-sound on|off|last
        Loops the sound that plays when the timer expires.

        Required        no
        Default value   last
        Alias           -r, /r

  --open-saved-timers on|off|last
        Opens all the saved timers on start up.

        Required        no
        Default value   last
        Alias           -v, /v

  --prefer-24h-time on|off|last
        When the input used to start the timer contains a time of day that does
        not explicitly specify "am" or "pm", prefer interpreting the input as a
        24-hour time rather than the closest 12-hour time to the current time.

        For example, if the current time is 3:00 pm (15:00) and the input is
        "until 05:00" the timer will
        - if this setting is on, count down until 5:00 am (05:00); or
        - if this setting is off, count down until 5:00 pm (17:00).

        Required        no
        Default value   last
        Alias           -j, /j

  --window-title none|app|left|elapsed|title|last
        Sets the timer window title.

        The options are:

            none            Hides the timer window title bar.

            app             Application name

            left            Time remaining
            elapsed         Time elapsed
            title           Timer title

            left+title      Time remaining · Timer title
            elapsed+title   Time elapsed · Timer title

            title+left      Timer title · Time remaining
            title+elapsed   Timer title · Time elapsed

        Required        no
        Default value   last
        Alias           -i, /i

  --window-state normal|maximized|minimized|last
        Sets the state of the timer window.

        Required        no
        Default value   last
        Alias           -w, /w

  --window-bounds <left>,<top>,<width>,<height>
        Sets the size and position of the timer window.

        <left> and <top> specify the position of the window's left and top
        edges respectively in relation to the desktop in device-independent
        pixels. If you specify auto for either of the <left> or <top> values,
        the window will be positioned automatically.

        <width> and <height> specify the width and height of the window
        respectively in device-independent pixels. If you specify auto for
        either of the <width> or <height> values, the window will be sized
        automatically.

        Required        no
        Default value   last
        Alias           -b, /b

  --lock-interface on|off
        Prevents the user from starting, pausing, stopping, or restarting the
        timer, changing the timer options, or closing the timer window until the
        timer expires.

        This option is never remembered. It must be specified as a command-line
        argument each time the timer is started.

        Timers that are started with this option turned on never appear in the
        "Saved timers" list.

        Required        no
        Default value   off
        Alias           -z, /z

  --use-factory-defaults
        If specified, any options that are not explicitly set with another
        switch are set to their factory default setting rather than the last
        used setting.

        The factory default settings are:
            --title                       -t  (none)
            --always-on-top               -a  off
            --full-screen                 -f  off
            --prompt-on-close             -o  on
            --show-progress-in-taskbar    -y  on
            --do-not-keep-awake           -k  off
            --show-in-notification-area   -n  off
            --reverse-progress-bar        -g  off
            --activate-next               -an on
            --digital-clock-time          -c  off
            --show-time-elapsed           -u  off
            --show-trigger-time           -st off
            --multi-timers                -mt off
            --loop-timer                  -l  off
            --pause-after-loop-timer      -pl off
            --pop-up-when-expired         -p  on
            --close-when-expired          -e  off
            --shut-down-when-expired      -x  off
            --theme                       -m  accent
            --sound                       -s  normal beep
            --loop-sound                  -r  off
            --open-saved-timers           -v  off
            --prefer-24h-time             -j  off
            --window-title                -i  app
            --window-state                -w  normal
            --window-bounds               -b  auto,auto,355,160
            --lock-interface              -z  off

        Required        no
        Alias           -d, /d

  --help
        Shows this message.

        Required        no
        Alias           -h, -?, /h, /?