SURFRAW...ATE-PATH(1)

πŸ’– SURFRAW-...-ATE-PATH πŸ’– (okay it's literally surfraw-update-path)

bestie this is a section 1 manual page from the User Contributed Perl Documentation, and it's all about the lil script that goes surfraw-update-path. say it with me now: surfraw-update-path ✨


πŸŽ€ NAME πŸŽ€

surfraw-update-path</ppurple> β€” no cap, all it does is update PATH in your shell config files πŸ¦‹


✨ SYNOPSIS ✨

surfraw-update-path [-add] [-remove] [-check] [-sys] [-all] [-help]
[-shell=SHELL]

that's it, that's the whole vibe πŸ’…


🌸 DESCRIPTION 🌸

okay so here's the tea πŸ“: surfraw-update-path takes the surfraw elvi directory β€” which is /usr/lib/surfraw β€” and adds it to your PATH inside your shell's config file. iconic behaviour honestly.

as of right now it supports bash, sh, csh, tcsh, ash, dash, ksh, pdksh, zsh, rc, and es πŸ‘‘

🚨 do NOT forget to log in again or source your login files, because otherwise it literally will not take effect. not me being dramatic, that's just the facts 😭

πŸ’… OPTIONS πŸ’…

  • -check β€” peeks to see if the surfraw config code is even there. this is the default, so if you don't say anything, this is what you get 🫢
  • -add β€” adds the surfraw config code. slay ✨
  • -remove β€” removes the surfraw config code. we love a clean exit πŸ’–
  • -sys β€” updates the system-wide shell config instead of the user one. you MUST do this as root, no exceptions, that's not a suggestion bestie 🚨
  • -shell=SHELL β€” picks which shell to configure. defaults to whatever's chillin' in the $SHELL environment variable 🌈

currently supported shells are:

  • sh, ash, bash, dash, csh, tcsh, ksh, pdksh, zsh, rc, and es 🐚
  • -all β€” tries to configure the startup files for all known shells. go big or go home, main character energy fr fr πŸ‘‘
  • -help β€” gives you a usage message πŸ’œ

⭐ RETURN VALUE ⭐

  • -check returns 0 if the surfraw code is present in the file, 1 if it is not found, or 2 on error πŸ‘€
  • all the other options return 0 on success, or 2 on error πŸ’€

πŸ¦‹ ENVIRONMENT πŸ¦‹

  • SHELL β€” used to figure out which shell to configure, but only if -shell isn't given 🌸
  • HOME β€” used to find the user's config files 🏠
  • ENV β€” used by posix-compliant shells to specify a startup rc file ✨
  • ZDOTDIR β€” used to find user config files for zsh. if it's not set, it defaults to HOME πŸ’œ

🌈 SEE ALSO 🌈

surfraw(1), sh(1), ash(1), bash(1), dash(1), csh(1), tcsh(1), ksh(1), pdksh(1), zsh(1), rc(1), es(1) β€” go read the girlies too, they're all connected 🫢


πŸ‘‘ AUTHOR πŸ‘‘

Ian Beckwith <ianb@erislabs.net> β€” thank u king πŸ™πŸ’–


and that's the whole page, bestie! this one was written by perl v5.36.0 and dated 2022-12-29, and it's the SURFRAW...ATE-PATH(1) page (yes the header really does truncate the name like that, iconic honestly πŸ’…). now go source your login files, i'm not asking twice πŸ˜­βœ¨πŸ¦‹πŸ’–

πŸ“¦ where this page comes from