view release on metacpan or  search on metacpan

chart  view on Meta::CPAN

__END__

=for stopwords Gtk BHP BHP.AX bh wildcards Wildcards filenames tty ie watchlist Watchlist --watchlist SQLite Ryde

=head1 NAME

chart -- Stock and commodity price charting and downloading

=head1 SYNOPSIS

chart [--options] [symbol...]

=head1 DESCRIPTION

Chart is a stock and commodity charting program written in Perl and using
the Gtk toolkit.

For a summary of the command line options run C<chart --help>.  Full
documentation is provided in the manual:

=over 4

=item F<doc/chart.info>

Info format, can be viewed with Emacs or the stand-alone Info viewer.

=item F<lib/App/Chart/doc/chart.html>

HTML, can be viewed from within Chart (Help/Manual menu entry), or with any
browser.

=back

=head1 OPTIONS

The default is to start the Gtk graphical interface, with an optional
initial symbol to display.  Just a part of a symbol can be given, the same
as in the File/Open dialog, so for instance

    chart bh

is enough to start on BHP.AX, if that's the only "bh" in the database.

=over 4

=item --display=DPY

Specify the X display name for Gtk.  The default is the C<DISPLAY>
environment variable, as usual.  This is a standard Gtk option, see the
C<gtk-options> man page for others (none of which do much).

=item --download

Download data for the given symbols, lists, or wildcards instead of running
the GUI.  For example

    chart --download BHP.AX GM
    chart --download "*.NZ"
    chart --download --all

Wildcards usually have to be quoted to stop the shell expanding them as
filenames.  On a tty a status line is shown with progress.

=item --all

The "All" list of all current symbols (ie. non-historical) for download
etc.

=item --alerts

The "Alerts" list of symbols for download etc.

=item --favourites

The "Favourites" list of user symbols for download etc.

=item --watchlist

Start in the Watchlist dialog, with a selected symbols list, per the options
above, or the Favourites list by default.  For example

    chart --watchlist --all

=item --ticker

Run just the scrolling stock ticker display, not the whole GUI.  Symbols,
lists or wildcards select what to display (in order).  For example

    chart --ticker BHP.AX --favourites GM "*.NZ"

=item --verbose

Print extra messages (to standard output).  This is mainly for
C<--download>.

=item -v, --version

Print the program version number and exit.

=item -h, --help

Print a summary of the command line options and exit.

=back

=head1 ENVIRONMENT VARIABLES

=over 4

=item C<CHART_DIRECTORY>

Directory name to use instead of the default F<~/Chart>.

=item C<HOME>

For default F<~/Chart> directory.

=item C<TZ>

Local timezone.