Manpage

Below is the man page for the command line program. You can also get it directly in your terminal with the man kosmorro command.

Looking for some usage examples? Take a look at the tldr page!

SYNOPSIS

  • kosmorro
  • kosmorro [OPTIONS]...

OPTIONS

  • -h, --help
    show a help message and exit

  • --version, -v
    show the program version

  • --clear-cache
    delete all the files Kosmorro stored in the cache

  • --position="LATITUDE,LONGITUDE", -p "LATITUDE,_LONGITUDE"
    the observer's position on Earth

  • --date=DATE, -d DATE
    The date for which the ephemerides must be computed, either in the YYYY-MM-DD format or as an interval in the "[+-]YyMmDd" format (with Y, M, and D numbers); defaults to the current date

  • --timezone=TIMEZONE, -t TIMEZONE
    the timezone to use to display the hours; it can be either a number (e.g. 1 for UTC+1) or a timezone name (e.g. Europe/Paris)

  • --no-colors
    disable the colors in the console

  • --output=OUTPUT, -o OUTPUT
    a file to export the output to; if not given, the standard output is used

  • --format=FORMAT, -f FORMAT (optional)
    the format under which the information have to be output; one of the following: text (plain text, like normal console output), json, tex (LaTeX), pdf. If no format is provided, the output format will be inferred from the extension of the output file

  • --no-graph
    present the ephemerides in a table instead of a graph; PDF output format only

--completion [SHELL]
generate completion scripts for the specified shell (bash, zsh, fish, powershell)

ENVIRONMENT VARIABLES

The environment variable listed below may be used instead of the options. The options have a higher priority than the environment variable. As a consequence, any option that would be given to kosmorro will override its corresponding environment variable.

Available environment variables are:

  • KOSMORRO_POSITION
    the observer's position on Earth (alternative to --position)

  • KOSMORRO_TIMEZONE
    the observer's timezone (alternative to --timezone)

  • NO_COLOR disable colored console output (alternative to --no-colors)

EXAMPLES

Compute the events only for the current date:

kosmorro

Compute the ephemerides for Lille, France, on April 1st, 2022:

kosmorro --latitude=50.5876 --longitude=3.0624 --date=2022-04-01

Compute the ephemerides for Lille, France, on April 1st, 2022, and export them in a PDF document:

kosmorro --latitude=50.5876 --longitude=3.0624 -date=2022-04-01 --output=file.pdf

AUTHOR

Written by Jérôme Deuchnord.

REPORTING BUGS

Please report any encountered bugs on Kosmorro's GitHub project.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.