PELICAN(1)

πŸ’– PELICAN(1) πŸ’–

okay bestie so this is the manual page for pelican, which lives in the User Commands section, and no cap it's giving "static blog generator with main character energy." ✨


πŸ¦‹ NAME πŸ¦‹

pelican β€” manages pelican plugins πŸ’…


🌸 DESCRIPTION 🌸

so like, here's the whole usage vibe, exactly as it comes:

usage: pelican [-h] [-t THEME] [-o OUTPUT] [-s SETTINGS] [-d] [-v] [-q]
[-D]

       [--version] [-r] [--print-settings [SETTING_NAME [SETTING_NAME
       ...]]]  [--relative-urls] [--cache-path CACHE_PATH]
       [--ignore-cache] [-w SELECTED_PATHS] [--fatal errors|warnings]
       [--logs-dedup-min-level {DEBUG,INFO,WARNING,ERROR}] [-l] [-p
       PORT] [-b BIND] [path]

It's a tool to generate a static blog, with restructured text input files. yes literally. a whole blog. from restructured text. iconic behavior fr fr πŸŽ€

🧚 positional arguments 🧚

  • path β€” the path where to find the content files. (default: None) 🌈

πŸ‘‘ optional arguments πŸ‘‘

  • -h, --help β€” shows this help message and then dips. (default: none of your business, it just exits πŸ’€)
  • -t THEME, --theme-path THEME β€” path where to find the theme templates. If you don't specify it, it'll use the default one that ships with pelican. (default: None) πŸŽ€
  • -o OUTPUT, --output OUTPUT β€” where to output the generated files. If you don't specify it, a directory gets created, named "output" in the current path. (default: None) ✨
  • -s SETTINGS, --settings SETTINGS β€” the settings of the application, and this is automatically set to pelicanconf.py if a file exists with this name. (default: None) 🫢
  • -d, --delete-output-directory β€” deletes the output directory. (default: None) πŸ’…
  • -v, --verbose β€” shows all messages. every single one. (default: None) πŸ”₯
  • -q, --quiet β€” shows only critical errors. shhh era. (default: None) πŸ™ˆ
  • -D, --debug β€” shows all messages, including debug messages. full yapping mode, lowkey. (default: None) πŸ’€
  • --version β€” prints the pelican version and exits. periodt. (default: n/a, it's gone)
  • -r, --autoreload β€” relaunches pelican each time a modification occurs on the content files. it's watching. always watching. (default: False) πŸ‘€
  • --print-settings [SETTING_NAME [SETTING_NAME ...]] β€” prints the current configuration settings and exits. append one or more setting name arguments to see the values for specific settings only. (default: None) 🌟
  • --relative-urls β€” uses relative urls in output, which is useful for site development. (default: False) 🌈
  • --cache-path CACHE_PATH β€” the directory in which to store cache files. if you don't specify it, it defaults to "cache". (default: None) πŸ“
  • --ignore-cache β€” ignores the content cache from previous runs by not loading cache files. starting fresh, bestie. (default: False) 🧚
  • -w SELECTED_PATHS, --write-selected SELECTED_PATHS β€” a comma separated list of selected paths to write. (default: None) ⭐
  • --fatal errors|warnings β€” exits the program with non-zero status if any errors/warnings are encountered. (default: ) πŸ’–
⚠️ heads up: that default really is just blank in the original β€” nothing after the colon. not me forgetting it, it's literally empty. πŸ™ˆ
  • --logs-dedup-min-level {DEBUG,INFO,WARNING,ERROR} β€” only enables log de-duplication for levels equal to or above the specified value. (default: WARNING) πŸ’œ
  • -l, --listen β€” serves content files via HTTP and port 8000. (default: False) πŸ”₯
  • -p PORT, --port PORT β€” the port to serve HTTP files at. (default: 8000) (default: None) 🌸
yes bestie, it says (default: 8000) (default: None) β€” both. I'm not merging them, that's literally what's there. πŸ’…
  • -b BIND, --bind BIND β€” the IP to bind to when serving files via HTTP. (default: 127.0.0.1) (default: None) πŸ¦‹

πŸŽ€ SEE ALSO πŸŽ€

The full documentation for pelican is maintained as a Texinfo manual. If the info and pelican programs are properly installed at your site, the command

info pelican

should give you access to the complete manual. go read it, it's giving scholar behavior πŸ“šβœ¨


and that's the whole page bestie, mwah πŸ’‹

this was pelican 4.0.1 and it was dated January 2021 β€” yeah she's a little vintage but she ATE and she's still slaying. bye pookie, go generate a blog πŸ«ΆπŸ’–πŸŒΈ