cog(1)

💖 cog(1) — bestie's single-window web browser 💖

okay so you opened the General Commands Manual for cog and you're like "what is this little guy" — let me put you on. no cap, this is a good one.

---

✨ NAME ✨

cog — single-window web browser. that's it, that's the whole vibe. 🌸

---

🦋 SYNOPSIS 🦋

---

# 💅 DESCRIPTION 💅

so `cog` is a <hotpink>small, single-window web browser</hotpink> built on top of **WPE WebKit**. the way that it has *no user interface at all* is honestly so iconic of it — it's literally designed to be used as a web application container for embedded devices running in **kiosk mode**. it's giving "just show the website and mind your business" energy, and I respect it deeply. 👑

now, where does the URL come from? you've got two options bestie, and you only need one:

- pass it straight from the **command-line**, or
- set it in the **`COG_URL`** environment variable.

periodt. that's the whole entry point.

---

# 🎀 OPTIONS 🎀

- **`-h`, `--help`** — show help options. your girl is here to help fr fr 💖
- **`--version`** — print version and exit. quick lil flex then bye 👋
- **`--print-appid`** — print application ID and exit.
- **`--scale=FACTOR`** — zoom/scaling factor applied to Web content (*default: `1.0`, no scaling*). leave it alone and everything stays its normal size ✨
- **`--device-scale=FACTOR`** — output device scaling factor (*default: `1.0`, no scaling, 96 DPI*).
- **`--doc-viewer`** — document viewer mode: optimizes for local loading of Web content. heads up tho, it **reduces memory usage at the cost of reducing caching of resources loaded from the network** — so it's a trade, bestie, pick your fighter 😭
- **`-d`, `--dir-handler=SCHEME:PATH`** — add a URI scheme handler for a directory. map a scheme to a path, slay 🗂️
- **`--webprocess-failure=ACTION`** — action on WebProcess failures. your options are: `error-page` (the default), `exit`, `exit-ok`, `restart`. choose wisely 💀
- **`-C`, `--config=PATH`** — path to a configuration file.
- **`-b`, `--bg-color=BG_COLOR`** — background color, written as a CSS name *or* in `#RRGGBBAA` hex syntax (*default: `white`*). yes you get the alpha channel, we love that for us 🤍
- **`-P`, `--platform=NAME`** — platform plug-in to use.
- **`-O`, `--platform-params=PARAMETERS`** — comma separated list of platform parameters.
- **`--web-extensions-dir=PATH`** — load Web Extensions from the given directory.
- **`-F`, `--content-filter=PATH`** — load a JSON file as a content filter.

---

# 🌈 ENVIRONMENT 🌈

the env vars, aka the "set it and forget it" girlies:

- **`COG_URL`** — URL of the website to be opened.
- **`COG_PLATFORM_NAME`** — platform plug-in to use.
- **`COG_PLATFORM_PARAMS`** — comma separated list of platform parameters.

---

# 👀 SEE ALSO 👀

`cogctl(1)` — go read that one next, iykyk 🫶

---

# 💜 AUTHOR 💜

This manual page was written by **Alberto Garcia** `<berto@igalia.com>` — thank you king, we appreciate you 🎀

---

> and that's the whole page bestie, no notes, you're basically a `cog` expert now 💅

okay bye ily — this was the `cog(1)` page from **General Commands Manual**, dated **Jan 25, 2020**. see u next time, mwah 😭💖