NAME

clock - display the time in an icon or window

SYNOPSIS

clock [ -Wn ] [ +Wn ] [ -T ] [ -TZ timezone ] [ -12 ] [ -24 ] [ -alarm setting ]

[ -alarmtime hr:min ] [ -alarmcmd cmd ] [ -analog ] [ -digital ] [ +date ] [ -date ] [ -help ] [ -hourcmd cmd ] [ -name app-name ] [ -r ] [ +seconds ] [ -seconds ] [ -v ] [ -? ]

AVAILABILITY

Although this command is available with both the SunView software installation option and the OpenWindows environment, its appearance is not the same for both environments. The man page you are currently viewing refers to the clock that is available with OpenWindows. The primary difference between this and the SunView clock is the user interface. All OpenWindows standard tools use the OPEN LOOK Graphical User Interface.

DESCRIPTION

clock is an OpenWindows XView utility that displays the current time in a window or icon. When the window is open, clock can display the time in either analog or digital format. The clock window is scalable in either format.

OPTIONS

-Wn

Start clock with no title line.

+Wn

Start clock with a title line present.

-T

Start the clock in test mode. Test mode ignores the real time, and instead runs in a loop continuously incrementing the time by one minute and displaying it.

-TZ timezone
        Start the clock with an alternate time zone.

-12

If the digital clock is being displayed in the open window, then use a 12 hour clock.

-24

If the digital clock is being displayed in the open window, then use a 24 hour clock.

-alarm setting

Set how often you want the alarm to go off. Choices are "none", "once" and "daily".

-alarmtime hr:min

The time you want the alarm to go off.

-alarmcmd cmd

The command you want to run, when the alarm does go off.

-analog

Start up the open window display with the analog clock.

-digital

Start up the open window display with the digital clock.

+date

Show the current date in the open window.

-date

Do not show the current date in the open window.

-help

Lists generic XView options that can be applied to the clock.

-hourcmd cmd

The command you would like run every hour, on the hour.

-name app-name

This option specifies the application name under which resources are to be obtained, rather than the default executable file name. app-name should not contain ``.'' or ``* ''characters.

-r

Use a face with roman numerals in the iconic state. This replaces the default round face.

+seconds

Show the number of seconds. For the analog clock (and in the iconic state), the seconds are shown by displaying a second hand. For the digital display, seconds are shown as a numeric value.

-seconds

Do not show the number of seconds.

-v

Show the version number and the usage message for this version of clock.

-?

Show the version number and the usage message for this version of clock.

USAGE

When the clock window is open, it has a floating menu from which you can bring up a property window. From this property sheet, you can modify the open window clock face of the tool by selecting either the Analog or Digital choice box.

The icon displayed, can be either an analog or roman clock face. With the digital display, you can select between a 12-hour or a 24-hour display.

Seconds:

On the analog version, this selection starts a second hand on the face of the clock. On the digital version, it adds two digits to the digital readout.

Date:

Turns on a date display for both analog and digital versions of clock.

You can select a local timezone or set it to monitor a remote timezone by clicking SELECT on other, then choosing a timezone by pressing MENU over the abbreviated menu button displayed.

The stopwatch is an automatic function, and allows you to reset, start and stop a stopwatch to second accuracy. This should be set to none, to disable it.

An alarm can be set, and when that time occurs, then a command can be run. The alarm can be triggered once or daily. If no alarm command is present, then the clock will just beep.

You can also set a command that will be run every hour on the hour.

There are various keyboard accelerators that can be used with the clock. These are:

1

set 12hr mode if currently showing a digital display.

2

set 24hr mode if currently showing a digital display.

c

toggle clock face between analog and digital.

d

toggle on and off the date display.

i

toggle icon face between analog and roman.

s

toggle on and off the seconds display.

S

set stopwatch. Cycles between reset, start and stop. Hit c to continue in normal clock display.

t

toggle the timezone between local and other. Note that you have to have a valid other timezone for this to work properly.

T

toggle test mode on and off.

q

quit the clock

On startup, the clock will use the following X resources:

Resource:

deskset.clock.faceAnalog

Values:

True, False (True)

Description

Setting for the open clock face. Choices are analog and digital.

Resource:

deskset.clock.iconAnalog

Values:

True, False (True)

Description

Setting for the closed clock icon. Choices are analog and roman.

Resource:

deskset.clock.iconHasWindowColor

Values:

True, False (False)

Description

Determines whether the clock icon should use the window background color. By default, it uses the workspace color.

Resource:

deskset.clock.digital12Hour

Values:

True, False (True)

Description

Setting for digital displays. Choices are 12 hour and 24 hour display.

Resource:

deskset.clock.showLocal

Values:

True, False (True)

Description

Indicates whether the local or other timezone should be initially displayed.

Resource:

deskset.clock.secondHand

Values:

True, False (False)

Description

When True, a second hand (for analog) or a seconds value (for digital) will be displayed.

Resource:

deskset.clock.date

Values:

True, False (False)

Description

When True, the current date will be displayed.

Resource:

deskset.clock.timeZone

Values:

Timezone (string)

Description

If present, the timezone to monitor.

Resource:

deskset.clock.alarmHrValue

Values:

Hour value (numeric)

Description

The hour value for the alarm command.

Resource:

deskset.clock.alarmMinValue

Values:

Minute value (numeric)

Description

The minute value for the alarm command.

Resource:

deskset.clock.alarmChoice

Values:

None, Once, Daily (None)

Description

How often the alarm should go off. Choices are none, once and daily.

Resource:

deskset.clock.alarmCommand

Values:

Command (string)

Description

The command that should be run when the alarm goes off.

Resource:

deskset.clock.hourlyCommand

Values:

Command (string)

Description

The command that should be run every hour, on the hour.

Resource:

deskset.clock.dateFont

Values:

Font name string

Description

The name of the font used to display the date and timezone, irrespective of the current size and scale of clock

Resource:

deskset.clock.secondsFont

Values:

Font name string

Description

The name of the font used to display the number of seconds when in digital mode, plus the am/pm values if in 12 hour mode, irrespective of the current size and scale of clock

Resource:

deskset.clock.hasTitle

Values:

True, False (True)

Description

Indicates whether the clock window has a title line.

ENVIRONMENT

The clock uses the TZ environment variable to determine the local time, and the initial setting for the other timezone. The latter can be over-ridden in a variety of ways.

SEE ALSO

OpenWindows user documentation

"About the Clock" in the Help Handbook available through the Help option on the Workspace menu.