GKRELLKAM-LIST(5)

✨ GKRELLKAM-LIST ✨ (section 5 of the manual, bestie) πŸŽ€

okay so this is the gkrellkam-list page β€” it's in the File Formats Manual section, and it's literally all about how to format the list description files that GKrellKam eats for breakfast. πŸ’…


🌸 NAME 🌸

gkrellkam-list β€” the format of the list description files used by GKrellKam πŸ¦‹


πŸ’– DESCRIPTION πŸ’–

so a GKrellKam list is basically a lil roster of image sources. GKrellKam walks through them in order, or just picks them at random, whatever vibe it's on that day. ✨ And listen β€” online lists, like the ones GKrellKam downloads over HTTP? same syntax. no cap.

Blank lines? ignored. Comments starting with #? also ignored. 🚫 Every line of text that does not start with a tab character is considered an image source, periodt.

An image source can be one of these types:

  • image β€” sources of type image are just a complete local filename pointing at an image file. simple. iconic.
  • url β€” type url is literally just that: a ftp:// or http:// or https:// URL pointing at an online image file. 🌈 And everything after the first space character gets treated as a parameter to wget. iykyk.
  • script β€” type script is a system command, executed in a shell by GKrellKam when it's time to grab this image. The command's output is assumed to be a complete filename of a local image file, optionally terminated with newlines/whitespace. Then the corresponding image gets loaded. 🫢
  • list β€” type list makes a whole different GKrellKam list get included in the current one. nesting!! main character energy.

Each image source line should look like this:

type: name

The "type: " part of the line can be omitted for images and URLs, so these list files stay backwards compatible with earlier versions of GKrellKam β€” but bestie, please specify them anyway. It genuinely enhances the readability of the list file. trust. πŸ’œ

There are also properties that can be applied to the types image, url, and script. Properties have to follow the image source line they modify, and they must begin with a tab character. Here's the lineup:

  • tooltip [message] β€” this sets the message shown when the mouse hovers over the image panel in GKrellKam for a few seconds. If you don't set it, the image's filename or URL gets shown instead. πŸ™ˆ
  • seconds [num] β€” this changes how many seconds an image stays displayed. If you don't set it, the "Default number of seconds" set for that panel in the GKrellM configuration window is used. ⏱️
  • refresh [num] β€” if you set this, it sets the minimum length of time that must pass before the image is re-loaded. If the image cycles up before that time, the old image gets used. For script types, that means the script won't be re-run. For url types, the image won't be fetched using wget. When this property is not set, url images get downloaded every single time they're displayed, and scripts get run every single time. πŸ”₯

πŸŽ€ EXAMPLE πŸŽ€

here's a lil baby example of a GKrellKam list. for a better one, go look at example.list from this distribution. πŸ‘‘

# .krellkam.list
# This list rotates through ~/pics/mypic[1-4].jpg along with a
# webcam, and then displays the pictures in ~/lists/sub.list

image: /home/paul/pics/mypic1.jpg
/home/paul/pics/mypic2.jpg
image: /home/paul/pics/mypic3.jpg
http://www.usu.edu/webcam/fullsize.jpg --user-agent="not wget"
[tab] tooltip: This is the building where I work

image: /home/paul/pics/mypic4.jpg
[tab] seconds: 4
[tab] tooltip: Don't display this one very long

list: /home/paul/lists/sub.list

πŸ¦‹ FILES πŸ¦‹

  • $HOME/.krellkam.list β€” the default source for the first GKrellKam panel ✨
  • example.list β€” a sample GKrellKam list 🌸

πŸ‘‘ AUTHOR πŸ‘‘

GKrellKam was written by paul cannon <paul@cannon.cs.usu.edu>. This manual page was written by the same author for inclusion in the GKrellKam distribution, and may be used by others. 🫢


πŸ’œ SEE ALSO πŸ’œ

  • wget(8) ⭐

okay bestie that's the whole page, we ate and left no crumbs πŸ’…βœ¨ this one's from the GKrellKam distribution, dated Dec 7, 2001, and yeah β€” the GKrellKam list format lore is fully unlocked now. slay. πŸŽ€πŸ¦‹