starpkg(1)

πŸ“¦ version 0.95.5, in debian bookworm, fedora 43, fedora 44, ubuntu jammy

πŸ’« starpkg β€” a manual page, but make it cute πŸ’«

okay bestie, so this is starpkg, from the General Commands Manual section, and she's here to convert a StarPlot data set into StarPlot file format. literally that's her whole job. let's go πŸŽ€


✨ NAME ✨

starpkg β€” convert a StarPlot data set to StarPlot file format


πŸ¦‹ SYNOPSIS πŸ¦‹

starpkg [ --dataset ] data-set [ --dest destination ]
starpkg --recurse input-dir [ --dest destination ]

🌸 DESCRIPTION 🌸

so on the StarPlot web site there are these little packages of data, right? and each one has both an original data file from NASA and a specification file. we call these lil bundles "data sets", and starconvert(1) can turn them into a data file in StarPlot format. but for ease of use, bestie, you should really do it through the starpkg shell script. it's giving convenience. it's giving wrapper. πŸ’…


🧚 USAGE 🧚

okay so assuming that data-set is a valid StarPlot data set β€” and that means either a tar.gz format file or a directory that came from uncompressing that tar.gz β€” then the command

starpkg --dataset

converts it into a StarPlot-formatted data file. 🫢

not me pointing out that the --dataset flag is optional β€” you can literally just pass the name of the input data set without it. iconic behaviour.

now, for something to count as a valid StarPlot data set, a directory or tar.gz file must contain at least:

  • a valid specification file whose name ends with .spec, and
  • a flat text data file named catalog.dat.

that's it. that's the bar. πŸ’–


if the --dest option is omitted, the default location of the output file is the first of these directories in which the user has write permissions:

  1. /usr/share/starplot
  2. $PWD
  3. $HOME

and if --dest is omitted or destination is a directory, the name of the output file will by default be ${specfilename%.spec}.stars.

for instance, a data set containing gliese.3.spec will produce a file named gliese.3.stars. slay. ✨


the starpkg --recurse form of the command runs all of the above for every StarPlot data set contained in input-dir, and drops the resulting StarPlot data files into the directory destination. (and if the --dest option is omitted, the default destination directory is chosen exactly like we said above, bestie.)

this form of the starpkg command is most useful when a new version of StarPlot has been installed and you wish to regenerate all StarPlot data files from data sets using the new starconvert program. spring cleaning but for astronomy data. 🌈

πŸ’… OPTIONS πŸ’…

  • --dataset, -s β€” specify a directory or tar.gz file to use as a StarPlot data set.
  • --dest, -d β€” specify the file or directory in which to output StarPlot-format data files.
  • --quiet, -q β€” print only fatal errors to the terminal. she's silent, she's mysterious, she's not telling you anything unless it's dire. πŸ’€
  • --recurse, -r β€” specify a directory in which to search for StarPlot data sets.
  • --starconvert-option option β€” pass option through to starconvert. if you wish to pass more than one option (or an option that takes a following argument), you should give this flag multiple times, once for each starconvert option or argument. yes really, one flag per option. no grouping. it's giving tedious but it's giving correct. πŸ™ˆ
  • --verbose, -v β€” print all starconvert output to the terminal. main character energy, nothing hidden. πŸ‘‘

πŸŽ€ SEE ALSO πŸŽ€

starplot(1), starconvert(1)


πŸ‘‘ AUTHOR πŸ‘‘

Copyright Β© 2000-2002 under the GNU GPL by Kevin B. McCarty <starplot@starplot.org>. The StarPlot web page is at www.starplot.org. πŸ“


okay and that's the whole page, bestie β€” written back in Nov 2002, filed under starpkg(1), and honestly? still iconic. go convert something. bye πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from