Dotfiles/docs/html/utilities.html

404 lines
15 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Utilities — M-Archy Dotfiles</title>
<style>
/* ── CyberQueer Theme ──────────────────────────────────────────────── */
:root {
--bg: #1A1A1A;
--bg2: #242424;
--bg3: #2e2e2e;
--text: #D6ABAB;
--accent: #E40046;
--violet: #5018DD;
--danger: #F50505;
--border: #5018DD;
--radius: 10px;
--radius-sm: 5px;
}
/* ── Reset & Base ──────────────────────────────────────────────────── */
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
html { scroll-behavior: smooth; }
body {
background-color: var(--bg);
color: var(--text);
font-family: 'Agave Nerd Font Mono', 'JetBrains Mono', 'Fira Code',
'Cascadia Code', 'Source Code Pro', monospace;
font-size: 15px;
line-height: 1.75;
max-width: 960px;
margin: 0 auto;
padding: 2.5rem 2rem 5rem;
}
/* ── Typography ────────────────────────────────────────────────────── */
h1, h2, h3, h4, h5, h6 {
font-family: 'Agave Nerd Font Mono', monospace;
font-weight: 700;
line-height: 1.25;
margin-top: 2.2rem;
margin-bottom: 0.6rem;
}
h1 {
color: var(--accent);
font-size: 2.2rem;
border-bottom: 3px solid var(--accent);
padding-bottom: 0.4rem;
margin-top: 0;
}
h2 {
color: var(--accent);
font-size: 1.55rem;
border-bottom: 2px solid var(--violet);
padding-bottom: 0.3rem;
}
h3 {
color: var(--violet);
font-size: 1.2rem;
}
h4, h5, h6 {
color: var(--text);
font-size: 1rem;
}
p {
margin: 0.9rem 0;
}
strong { color: var(--accent); font-weight: 700; }
em { color: var(--violet); font-style: italic; }
/* ── Links ─────────────────────────────────────────────────────────── */
a {
color: var(--violet);
text-decoration: none;
border-bottom: 1px solid transparent;
transition: color 0.15s, border-color 0.15s;
}
a:hover {
color: var(--accent);
border-bottom-color: var(--accent);
}
/* ── Code ──────────────────────────────────────────────────────────── */
code {
font-family: inherit;
background: var(--bg2);
color: var(--violet);
border: 1px solid var(--violet);
border-radius: var(--radius-sm);
padding: 0.1em 0.42em;
font-size: 0.9em;
}
pre {
background: var(--bg2);
border: 2px solid var(--violet);
border-radius: var(--radius);
padding: 1.2rem 1.4rem;
overflow-x: auto;
margin: 1.2rem 0;
position: relative;
}
pre code {
background: transparent;
border: none;
padding: 0;
color: var(--text);
font-size: 0.875em;
line-height: 1.6;
}
/* Syntax-like token colouring (no JS required — structural only) */
pre code .kw { color: var(--accent); }
pre code .str { color: var(--violet); }
pre code .cm { color: #666; font-style: italic; }
/* ── Horizontal Rule ───────────────────────────────────────────────── */
hr {
border: none;
border-top: 2px solid var(--violet);
margin: 2rem 0;
opacity: 0.45;
}
/* ── Blockquote ────────────────────────────────────────────────────── */
blockquote {
border-left: 4px solid var(--accent);
background: var(--bg2);
margin: 1.2rem 0;
padding: 0.8rem 1.2rem;
border-radius: 0 var(--radius) var(--radius) 0;
color: var(--text);
opacity: 0.9;
}
blockquote p { margin: 0; }
/* ── Tables ────────────────────────────────────────────────────────── */
table {
width: 100%;
border-collapse: collapse;
border: 2px solid var(--border);
border-radius: var(--radius);
overflow: hidden;
margin: 1.2rem 0;
font-size: 0.9em;
}
th {
background: var(--violet);
color: var(--bg);
text-align: left;
padding: 0.55rem 0.9rem;
font-weight: 700;
letter-spacing: 0.03em;
}
td {
padding: 0.5rem 0.9rem;
border-top: 1px solid var(--bg3);
vertical-align: top;
}
tr:nth-child(even) td { background: var(--bg2); }
tr:hover td { background: var(--bg3); }
/* ── Lists ─────────────────────────────────────────────────────────── */
ul, ol {
padding-left: 1.6rem;
margin: 0.7rem 0;
}
li { margin: 0.25rem 0; }
ul li::marker { color: var(--accent); }
ol li::marker { color: var(--violet); font-weight: 700; }
/* ── Nav sidebar (index page) ──────────────────────────────────────── */
nav ul {
list-style: none;
padding: 0;
}
nav li { margin: 0.3rem 0; }
/* ── Page Header Bar ───────────────────────────────────────────────── */
.page-header {
border-bottom: 3px solid var(--accent);
padding-bottom: 0.6rem;
margin-bottom: 2rem;
display: flex;
align-items: baseline;
gap: 1rem;
}
.page-header .site-title {
color: var(--accent);
font-size: 0.85rem;
opacity: 0.75;
white-space: nowrap;
}
/* ── Back link ─────────────────────────────────────────────────────── */
.back-link {
display: inline-block;
color: var(--violet);
font-size: 0.85rem;
margin-bottom: 1.5rem;
padding: 0.25rem 0.75rem;
border: 1px solid var(--violet);
border-radius: 30px;
transition: background 0.15s, color 0.15s;
}
.back-link:hover {
background: var(--violet);
color: var(--bg);
border-bottom-color: transparent;
}
/* ── Footer ────────────────────────────────────────────────────────── */
footer {
margin-top: 4rem;
padding-top: 1rem;
border-top: 1px solid var(--bg3);
color: var(--text);
opacity: 0.4;
font-size: 0.8rem;
text-align: center;
}
/* ── Responsive ────────────────────────────────────────────────────── */
@media (max-width: 680px) {
body { padding: 1.2rem 1rem 3rem; font-size: 14px; }
h1 { font-size: 1.7rem; }
h2 { font-size: 1.3rem; }
table { display: block; overflow-x: auto; }
}
/* ── Selection ─────────────────────────────────────────────────────── */
::selection {
background: var(--accent);
color: var(--bg);
}
/* ── Scrollbar ─────────────────────────────────────────────────────── */
::-webkit-scrollbar { width: 8px; height: 8px; }
::-webkit-scrollbar-track { background: var(--bg2); }
::-webkit-scrollbar-thumb { background: var(--violet); border-radius: 4px; }
::-webkit-scrollbar-thumb:hover { background: var(--accent); }
</style>
</head>
<body>
<header class="page-header">
<span class="site-title">M-Archy Dotfiles</span>
</header>
<a class="back-link" href="index.html">← Index</a>
<main>
<h1 id="utilities">Utilities<a class="toc-anchor" href="#utilities" title="Permanent link">&para;</a></h1>
<p>Miscellaneous scripts and tools that live at the top level or in the <code>clamav/</code> directory.</p>
<hr />
<h2 id="system-update">System Update<a class="toc-anchor" href="#system-update" title="Permanent link">&para;</a></h2>
<pre><code class="language-bash">bash ~/Dotfiles/update.sh
</code></pre>
<p>Runs a full system update:
1. <code>sudo pacman -Syu</code> — official repos
2. <code>yay -Syu --answerdiff None --answerclean All --removemake</code> — AUR packages (no prompts)</p>
<p>For per-package AUR updates with confirmation:</p>
<pre><code class="language-bash">bash ~/Dotfiles/update-aur-onebyone.sh
</code></pre>
<hr />
<h2 id="package-audit">Package Audit<a class="toc-anchor" href="#package-audit" title="Permanent link">&para;</a></h2>
<pre><code class="language-bash">bash ~/Dotfiles/setup/audit-packages.sh
</code></pre>
<p>Audits installed packages — useful for finding orphans or unexpected installations.</p>
<hr />
<h2 id="encryption-utilities">Encryption Utilities<a class="toc-anchor" href="#encryption-utilities" title="Permanent link">&para;</a></h2>
<p>Simple OpenSSL wrappers for encrypting/decrypting arbitrary strings. Useful for storing secrets in scripts or config files without plaintext exposure.</p>
<h3 id="encrypt">Encrypt<a class="toc-anchor" href="#encrypt" title="Permanent link">&para;</a></h3>
<pre><code class="language-bash">bash ~/Dotfiles/encrypt.sh &quot;my secret text&quot; &quot;my-passphrase&quot;
# Output: base64-encoded AES-256-CBC ciphertext
</code></pre>
<h3 id="decrypt">Decrypt<a class="toc-anchor" href="#decrypt" title="Permanent link">&para;</a></h3>
<pre><code class="language-bash">bash ~/Dotfiles/decrypt.sh &quot;&lt;ciphertext&gt;&quot; &quot;my-passphrase&quot;
# Output: original plaintext
</code></pre>
<p>Both use AES-256-CBC with PBKDF2 key derivation via OpenSSL.</p>
<hr />
<h2 id="credential-storage">Credential Storage<a class="toc-anchor" href="#credential-storage" title="Permanent link">&para;</a></h2>
<h3 id="initial-setup">Initial Setup<a class="toc-anchor" href="#initial-setup" title="Permanent link">&para;</a></h3>
<pre><code class="language-bash">bash ~/Dotfiles/setup-creds-missing.sh
</code></pre>
<p>Installs <code>gnome-keyring</code> and <code>seahorse</code> (GUI manager), then sets git's credential helper to <code>store</code>.</p>
<h3 id="git-credentials">Git Credentials<a class="toc-anchor" href="#git-credentials" title="Permanent link">&para;</a></h3>
<p><code>git/</code> contains <code>.gitconfig</code> with:</p>
<pre><code class="language-ini">[user]
name = The_miro
email = amir@abdelbaki.eu
[credential]
helper = store
[init]
defaultBranch = main
[push]
autoSetupRemote = true
</code></pre>
<p>The <code>store</code> helper writes credentials to <code>~/.git-credentials</code>. For higher security, <code>gnome-keyring</code> intercepts this and stores the credentials in the system keyring instead of plaintext.</p>
<hr />
<h2 id="zsh-plugins">Zsh Plugins<a class="toc-anchor" href="#zsh-plugins" title="Permanent link">&para;</a></h2>
<pre><code class="language-bash">bash ~/Dotfiles/zshplugins.sh
</code></pre>
<p>Clones (or updates) the two Oh My Zsh community plugins:
- <code>zsh-syntax-highlighting</code> — real-time syntax colouring in the prompt
- <code>zsh-autosuggestions</code> — fish-style history-based suggestions</p>
<p>These are referenced in <code>.zshrc</code> and active after the next shell start.</p>
<hr />
<h2 id="clamav-on-access-scanning">ClamAV On-Access Scanning<a class="toc-anchor" href="#clamav-on-access-scanning" title="Permanent link">&para;</a></h2>
<p>Full real-time antivirus scanning via ClamAV's <code>clamonacc</code> daemon.</p>
<h3 id="installation">Installation<a class="toc-anchor" href="#installation" title="Permanent link">&para;</a></h3>
<pre><code class="language-bash">bash ~/Dotfiles/clamav/install-clam-onaccess.sh
</code></pre>
<p>What it does:
1. Installs <code>clamav</code>
2. Copies <code>clamd.conf</code> to <code>/etc/clamav/</code>
3. Installs <code>clamav-clamonacc.service</code> to <code>/etc/systemd/system/</code>
4. Installs the sudoers entry from <code>clamav-sudoer</code>
5. Updates virus definitions (<code>freshclam</code>)
6. Enables and starts <code>clamd</code> + <code>clamav-clamonacc</code></p>
<h3 id="key-files">Key Files<a class="toc-anchor" href="#key-files" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>File</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>clamav/clamd.conf</code></td>
<td>Daemon configuration (30 KB, full options)</td>
</tr>
<tr>
<td><code>clamav/clamav-clamonacc.service</code></td>
<td>systemd unit for on-access scanning</td>
</tr>
<tr>
<td><code>clamav/clamav-sudoer</code></td>
<td>sudoers rule for ClamAV processes</td>
</tr>
<tr>
<td><code>clamav/virus-event.bash</code></td>
<td>Handler executed when a virus is detected</td>
</tr>
</tbody>
</table>
<h3 id="virus-event-handler">Virus Event Handler<a class="toc-anchor" href="#virus-event-handler" title="Permanent link">&para;</a></h3>
<p><code>virus-event.bash</code> is called by clamonacc when a threat is found. Customise it to send notifications, quarantine files, or alert an admin.</p>
<hr />
<h2 id="shell-configuration">Shell Configuration<a class="toc-anchor" href="#shell-configuration" title="Permanent link">&para;</a></h2>
<h3 id="zshrc"><code>.zshrc</code><a class="toc-anchor" href="#zshrc" title="Permanent link">&para;</a></h3>
<ul>
<li><strong>Framework</strong>: Oh My Zsh</li>
<li><strong>Theme</strong>: robbyrussell (overridden visually by Starship)</li>
<li><strong>Plugins</strong>: syntax-highlighting, autosuggestions</li>
<li><strong>Walk integration</strong>: <code>lk</code> function opens the <code>walk</code> file navigator</li>
<li><strong><code>WALK_MAIN_COLOR</code></strong>: set to <code>#5018DD</code> (CyberQueer violet)</li>
<li>Sources Starship init at the end</li>
</ul>
<h3 id="bashrc"><code>.bashrc</code><a class="toc-anchor" href="#bashrc" title="Permanent link">&para;</a></h3>
<p>Minimal bash config — sets <code>PS1</code>, loads <code>~/.bash_profile</code> if present.</p>
<h3 id="starship-prompt">Starship Prompt<a class="toc-anchor" href="#starship-prompt" title="Permanent link">&para;</a></h3>
<p><code>starship.toml</code> at the repo root is deployed to <code>~/.config/starship.toml</code>.</p>
<p>Key customisations:
- OS, username, directory, git, language, docker, and time segments
- CyberQueer colours throughout (colour-substitution target)
- Directory abbreviated to 3 levels with <code>…/</code> truncation
- Common directory substitutions (<code>~/Documents</code><code>📄</code>, etc.)</p>
<hr />
<h2 id="login-manager-ly">Login Manager (ly)<a class="toc-anchor" href="#login-manager-ly" title="Permanent link">&para;</a></h2>
<p><code>etc-ly-config.ini</code> is deployed to <code>/etc/ly/config.ini</code> during Hyprland install and kept as a colour-substitution target in <code>apply-theme.sh</code>.</p>
<p>ly is a minimal TUI display manager that runs on <code>tty1</code>:</p>
<pre><code>systemctl enable ly@tty1
</code></pre>
<p>Session selection, auto-login, and timeout settings are all in the config.</p>
</main>
<footer>
Generated by md-to-html.sh &nbsp;·&nbsp; CyberQueer theme &nbsp;·&nbsp; 2026-05-18
</footer>
</body>
</html>