GENERIC(1)

πŸ’– GENERIC(1) β€” the IRAF commands girlies πŸ’–

okay so bestie, welcome to the IRAF commands corner of the manual, section 1, and today's main character is mkiraf. she's not flashy but she is foundational, iykyk 🫢


✨ NAME ✨

mkiraf β€” Setup the IRAF environment for a user 🌸


✨ SYNOPSIS ✨

mkiraf [-d|--default] [-i|--init] [-n|--noinit] [-c|--copy] [-q|--quiet]

✨ DESCRIPTION ✨

okay so what does she actually do?? she creates the parameter directory, the image directory and the cache directory so you can use them with the IRAF CL, and if you want, she'll also make you a lil local copy of the IRAF CL startup file login.cl. iconic behavior honestly πŸ’…

inside IRAF CL, these directories answer to the names uparm$, imdir$, and cache$. yes they have cute little $ names. that's just how they are. πŸŽ€

so here's the tea on where things land: if you do not pass the -d|--default flag, the parameter directory uparm gets created in the local directory, which means your parameter storage is local. but β€” plot twist β€” if there's no local parameter directory hanging around, then a general user-specific parameter storage over in ${HOME}/.iraf/uparm is what gets used instead. meanwhile the image directory imdir and the cache directory cache are always created in ${HOME}/.iraf/. no exceptions, no discussion, that's just the vibe ✨


✨ OPTIONS ✨

  • -d, --default β€” makes the upar file live in the user-specific directory ${HOME}/.iraf instead of the local directory. the homebody option fr 🏠
  • -i, --init β€” initializes an empty uparm directory, which means it removes your old parameter settings. if you give neither -i|--init nor -n|--noinit, the command will just ask you whether the upar directory should be initialized. she's polite like that 😭
  • -n, --noinit β€” does not initialize the uparm directory if it already exists, so your old parameter settings stay safe and sound. and again: if neither -i|--init nor -n|--noinit is given, the command asks whether the upar directory should be initialized. same energy, opposite answer πŸ’œ
  • -c, --copy β€” creates a copy of the login.cl file in the local directory, or (if you gave the -d|--default flag) in the directory ${HOME}/.iraf. heads up bestie: these copies are only needed if local changes shall be applied. no unnecessary dupe files, we're not doing that πŸ™ˆ
  • -q, --quiet β€” suppresses output messages. shhh. silent mode. 🀫

✨ BUGS ✨

okay so this is the part where we hold hands and sigh together: IRAF should use XDG conform user directories in ${HOME}/.cache, ${HOME}/.local and ${HOME}/.config. that's it, that's the note. πŸ’€


✨ SEE ALSO ✨


✨ AUTHOR ✨

Created by Ole Streicher for the IRAF community πŸ‘‘


and that's the whole page, bestie!! this one came from IRAF 2.17.1, dated April 2023, and it lives in the GENERIC(1) slot. go set up that environment, you're gonna slay πŸŒˆπŸ’–πŸ¦‹

πŸ“¦ where this page comes from