view release on metacpan or  search on metacpan

script/satpass  view on Meta::CPAN

 utils ---- Astro::Coord::ECI::Utils

The viewer is whatever is the default for your system.

If you set the L<webcmd|/webcmd> parameter properly, this
command will launch the L<https://metacpan.org/> page for this
package, and any arguments will be ignored.

=item list

 satpass> list

This command displays the observing list. Each body's NORAD ID, name
(if available), dataset epoch, and orbital period are displayed. If
the observing list is empty, you get a message to that effect.

In addition to the global options, the following options are legal for
the list command:

-choose chooses bodies from the observing list. It works the same way
as the L<choose|/choose> command, but does not alter the observing
list. You can specify multiple bodies by specifying -choose multiple
times, or by separating your choices with commas. If -choose is not
specified, the whole observing list is displayed.

=item load

 satpass> load file ...

This command loads the contents of one or more files into the
observing list. The files must contain NORAD two- or three- line
element sets.

=item localize

 satpass> localize parameter_name ...

This command localizes the values of the given parameters. If done in a
macro or source file, this causes the old parameter values to be
restored when the macro or source file exits.

If you localize a parameter more than once in a given macro or source
file, the duplicate localizations are ignored.

=item macro

 satpass> macro name command ...

This command bundles one or more commands under the given name,
effectively creating a new command. If any of the component commands
contain whitespace, they must be quoted. This may require playing
games if the component command also requires quotes. For example:

 satpass> macro foo list 'pass \'today noon\' +7'

or equivalently (since single and double quotes mean the same thing
to the parser)

 satpass> macro foo list "pass 'today noon' +7"

Macro names must be composed entirely of alphanumerics and underscores
(characters that match \w, to be specific) and may not begin with an
underscore. As of version 0.008_03, B<macros may redefine built-in
commands.> A macro is undefined inside itself, so use of the name
inside the macro invokes the built-in. The macro becomes redefined
again when it exits. The built_in can still be accessed by prefixing
the string 'core.' to its name, e.g. 'core.quarters', whether or
not you have overridden the built_in with a macro.

If you specify a macro name with no definition, it deletes the current
definition of that macro, if any. You can change this behavior by
setting the L<explicit_macro_delete|/explicit_macro_delete> parameter
true; this will cause 'macro name' to list the named macro, and require
an explicit -delete to delete it. Macros can also be redefined, simply
by issuing the 'macro' command, naming the macro, and giving its
definition.

The macro command takes the following options in addition to the
global ones:

-brief lists the names of macros. If names are given, they are listed
provided they are currently defined. If no names are given, the names
of all defined macros are given.

-delete deletes the named macros. If no macro names are given, all
macros are deleted. A macro may also be deleted by giving its name
but no definition, but as of 0.009_01, B<this mechanism is deprecated
in favor of use of the -delete option.> The
L<explicit_macro_delete|/explicit_macro_delete> parameter may be used
to require an explicit -delete to delete macros.

-list lists the names and definitions of macros. If names are given,
they are listed if they are defined. If no names are given, all
defined macros are listed.

Macros may be nested - that is, a macro may be defined in terms of
other macros. A macro temporarily becomes undefined when it is called
to prevent endless recursion. It becomes defined again when it exits.

Be aware that there is no syntax checking done when the macro is
defined. You only find out if your macro definition is good by
trying to execute it.

=item magnitude_table

 satpass> magnitude_table ...

This command displays or maintains the satellite magnitude table. This
table is used to initialize satellite magnitudes.

See the L<Astro::Coord::ECI::TLE|Astro::Coord::ECI::TLE> documentation
for information on how this table is populated initially. If you have
installed Astro::SpaceTrack, you can update the status using one of the
commands that fetches magnitude data, such as C<'st mccants vsnames'>,
or you can update it using the 'add', 'clear', and 'drop' subcommands,
which are discussed in more detail below.

C<add> adds the given body to the magnitude table. The arguments are OID
and magnitude.

C<clear> clears the magnitude table.

C<drop> drops the given body from the magnitude table. The argument is
the OID to be dropped.

C<molczan> reloads the magnitude table with the contents of the named
Molczan-format file. An optional second argument is a magnitude offset
to be added to the magnitudes read.

C<quicksat> reloads the magnitude table with the contents of the named
Quicksat-format file. An optional second argument is a magnitude offset
to be added to the magnitudes read.

C<show> displays the contents of the magnitude table, as a series of
C<'magnitude_table add'> commands. If arguments are passed, only those
OIDs specified in the arguments are displayed.

=item pass

 satpass> pass start_time end_time increment

This command predicts visibility of the contents of the observing
list, in accordance with the various L</PARAMETERS>, between the given
start_time and end_time, using the given increment. See the
L</SPECIFYING TIMES> topic below for how to specify times. The increment
is in seconds, and does nothing useful unless the L<verbose|/verbose>
setting is true.

The position of the visible body is given in either elevation, azimuth,
and range or right ascension, declination, and range as seen from the
location of the observer, as determined by the value of the
L<local_coord|/local_coord> parameter. The geodetic latitude, longitude,
and altitude are also given.

The defaults are 'today noon', seven days after the start time, and 60
(seconds) respectively.