about summary refs log tree commit diff stats
path: root/hm/soispha/pkgs/scripts/apps/fupdate.1.md
diff options
context:
space:
mode:
authorSoispha <soispha@vhack.eu>2024-02-20 17:21:42 +0100
committerSoispha <soispha@vhack.eu>2024-02-20 17:21:42 +0100
commitf2bdeaed0bcf97a880fe36cfc8a050d1643120b8 (patch)
treeba4fe9c3ddf076529701c0e776ffef2104ac23d5 /hm/soispha/pkgs/scripts/apps/fupdate.1.md
parentrefactor(treewide): Add a `.sh` extension to shell scripts (diff)
downloadnixos-config-f2bdeaed0bcf97a880fe36cfc8a050d1643120b8.zip
refactor(treewide): Reformat all files with treefmt
This includes getting all shellscripts to pass shellcheck. To accomplish
this, some old scripts were removed
Diffstat (limited to 'hm/soispha/pkgs/scripts/apps/fupdate.1.md')
-rw-r--r--hm/soispha/pkgs/scripts/apps/fupdate.1.md18
1 files changed, 13 insertions, 5 deletions
diff --git a/hm/soispha/pkgs/scripts/apps/fupdate.1.md b/hm/soispha/pkgs/scripts/apps/fupdate.1.md
index b2b7bf4f..710e8fb7 100644
--- a/hm/soispha/pkgs/scripts/apps/fupdate.1.md
+++ b/hm/soispha/pkgs/scripts/apps/fupdate.1.md
@@ -3,29 +3,34 @@
 % May 2023
 
 # NAME
+
 fupdate - updates your flake, while checking for common mistakes
 
 # SYNOPSIS
-**fupdate** list of [*flake*|*&lt;some word&gt;*|*--help*|*-h*]
+
+**fupdate** list of \[*flake*|*\<some word>*|*--help*|*-h*\]
 
 # DESCRIPTION
+
 Argument can be stacked, this makes it possible to specify multiple targets to be updated in succession. See the Examples section for further details.
 
 No argument or *flake*
 : **fupdate**, when executed without arguments or with *flake*, will update your *flake.lock*, check for duplicate flake inputs, i.e., an input has an input declared, which you have also declared as input, and will run a script called *update.sh*, if you allow it.
 The allowance for the script is asked, when you run **fupdate** and the found script is not yet allowed. Furthermore, the allowance is based on the concrete sha256 hash of the script, so any changes will require another allowance.
 
-**&lt;some word&gt;** as argument
-: If the executable **update-&lt;some word&gt;** is reachable thought the PATH variable, than this is run. Otherwise, the program will exit.
+**\<some word>** as argument
+: If the executable **update-\<some word>** is reachable thought the PATH variable, than this is run. Otherwise, the program will exit.
 
 # OPTIONS
-**\-\-help**, **-h**
+
+**--help**, **-h**
 : Displays a help message and exit.
 
-**\-\-version**, **-v**
+**--version**, **-v**
 : Displays the software version and exit.
 
 # EXAMPLES
+
 **fupdate** or **fupdate flake**
 : Updates your *flake.lock*. See the Description section for further details.
 
@@ -36,6 +41,7 @@ The allowance for the script is asked, when you run **fupdate** and the found sc
 : First updates your flake, then, if the command succeeded, runs **update-sys**, afterweich **update-docs** is run.
 
 # FILES
+
 *update.sh*
 : This is supposed to be a shell script located in your flake base directory, i.e., the directory which contains both a *flake.nix* and a *flake.lock* file.
 
@@ -43,9 +49,11 @@ The allowance for the script is asked, when you run **fupdate** and the found sc
 : **fupdate** will store the hashes to the allowed *update.sh* files here.
 
 # BUGS
+
 Report bugs to <https://codeberg.org/soispha/flake_update/issues>.
 
 # COPYRIGHT
+
 Copyright (C) 2023  Soispha
 
 This program is free software: you can redistribute it and/or modify