You're welcome, by the way, I just pushed Offpunk 2.4-1 to
Debian unstable. It should be available for installation at
some point tomorrow. It includes the manual pages refreshes.
Have a nice day, :
Signed-off-by: Étienne Mollier <emollier@debian.org>
---
man/ansicat.1 | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/man/ansicat.1 b/man/ansicat.1
index 486a124..e133f94 100644
--- a/man/ansicat.1+++ b/man/ansicat.1
@@ -1,4 +1,4 @@
-.Dd August 27, 2023+.Dd November 25, 2024.Dt ANSICAT 1
.Os
.
@@ -11,21 +11,23 @@
.Op Fl \-format Ar RENDERER
.Op Fl \-mime Ar MIME
.Op Fl \-url Ar URL ...
+.Op Fl \-mode Ar MODE.Op Ar INPUT ...
.Nm
.Fl h | \-help
.
.Sh DESCRIPTION
-Ansicat is the rendering engine of the browser-.Xr offpunk 1 .-It will render nicely on the terminal any gemtext,-html,-gopher,-and a few other formats.-.Pp-.Xr Offpunk 1-is a command-line browser and feed reader dedicated to browsing the Web,-Gemini, Gopher and Spartan.+ansicat is a terminal rendering tool+that will render multiple formats+(HTML, Gemtext, RSS, Gophermap, Image)+into ANSI text and colors.+When used on a file,+ansicat will try to autodetect the format.+When used with standard input,+the format must be manually specified.+If the content contains links,+the original URL of the content can be specified+in order to correctly modify relatives links..Ss Positional arguments
.Bl -tag -width Ds -offset indent
.It Ar INPUT
--
2.45.2
This change updates netcache description to match the help argument
output, and includes newly introduced --ids argument. In addition,
it also includes missing description of --offline.
Signed-off-by: Étienne Mollier <emollier@debian.org>
---
man/netcache.1 | 50 ++++++++++++++++++++++++++++++++------------------
1 file changed, 32 insertions(+), 18 deletions(-)
diff --git a/man/netcache.1 b/man/netcache.1
index d792b4d..dcef81d 100644
--- a/man/netcache.1+++ b/man/netcache.1
@@ -1,4 +1,4 @@
-.Dd August 27, 2023+.Dd November 25, 2024.Dt NETCACHE 1
.Os
.
@@ -9,6 +9,7 @@
.Sh SYNOPSIS
.Nm
.Op Fl \-path
+.Op Fl \-ids.Op Fl \-offline
.Op Fl \-max\-size Ar MAX_SIZE
.Op Fl \-timeout Ar TIMEOUT
@@ -17,28 +18,22 @@
.Fl h | \-help
.
.Sh DESCRIPTION
-Netcache is the download and cache management engine of the browser-.Xr offpunk 1 .-It allows one to fetch a link and get its content,-writing the content through the local cache for ulterior reference.+Netcache is a command-line tool to retrieve,+cache and access networked content.+By default,+netcache will returns a cached version of a given URL,+downloading it only if a cache version doesn't exist.+A validity duration,+in seconds,+can also be given+so netcache downloads the content+only if the existing cache is older than the validity.+.PpNetcache can be forced into offline mode,
in order to only fetch resources from the local cache,
otherwise it would always refresh it from the version available online.
It is also useful for mapping a given URL to its location in the cache,
independently of whether it has been downloaded first.
-.Pp-Default cache path is-.Pa ~/.cache/offpunk .-Set-.Ev OFFPUNK_CACHE_PATH-environment variable to use another location.-.Bd -literal-OFFPUNK_CACHE_PATH=/home/ploum/custom-cache netcache.py gemini://some.url-.Ed-.Pp-.Xr Offpunk 1-is a command-line browser and feed reader dedicated to browsing the Web,-Gemini, Gopher and Spartan..Ss Positional arguments
.Bl -tag -width Ds -offset indent
.It Ar URL
@@ -50,6 +45,13 @@ download the URL and output the content.
show a help message and exit.
.It Fl \-path
output the path to the cache instead of the content of the URL.
+.It Fl \-ids+return a list of id's for the gemini-site+instead of the content of the cache.+.It Fl \-offline+do not attempt to download,+return the cached version instead,+or error if absent from the cache..It Fl \-max-size Ar MAX_SIZE
cancel download of items above that size.
The value is expressed in megabytes.
@@ -63,6 +65,18 @@ Maximum age (in second) of the cached version before redownloading a new version
.Sh EXIT STATUS
.Ex -std
.
+.Sh ENVIRONMENT+Set+.Ev OFFPUNK_CACHE_PATH+environment variable to use another location.+.Bd -literal+OFFPUNK_CACHE_PATH=/home/ploum/custom-cache netcache.py gemini://some.url+.Ed+.+.Sh FILES+Default cache path is+.Pa ~/.cache/offpunk .+..Sh SEE ALSO
.Xr ansicat 1 ,
.Xr migrate-offpunk-cache 1 ,
--
2.45.2
[PATCH 3/4] man/offpunk.1: refresh manual for offpunk 2.4.
Export this patch
This change removes references to --tls-* arguments and documents
the --images-mode.
Signed-off-by: Étienne Mollier <emollier@debian.org>
---
man/offpunk.1 | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/man/offpunk.1 b/man/offpunk.1
index 195c481..d72ce6c 100644
--- a/man/offpunk.1+++ b/man/offpunk.1
@@ -1,4 +1,4 @@
-.Dd March 3, 2023+.Dd November 25, 2024.Dt OFFPUNK 1
.Os
.
@@ -9,13 +9,12 @@
.Sh SYNOPSIS
.Nm
.Op Fl \-bookmarks
-.Op Fl \-tls\-cert Ar FILE-.Op Fl \-tls\-key Ar FILE.Op Fl \-sync
.Op Fl \-assume\-yes
.Op Fl \-disable\-http
.Op Fl \-fetch\-later
.Op Fl \-depth Ar DEPTH
+.Op Fl \-images\-mode Ar IMAGES_MODE.Op Fl \-cache\-validity Ar CACHE_VALIDITY
.Op Ar URL ...
.Nm
@@ -47,10 +46,6 @@ start with this URL
Show a help message and exit
.It Fl \-bookmarks
start with your list of bookmarks
-.It Fl \-tls\-cert Ar FILE-TLS client certificate file-.It Fl \-tls\-key Ar FILE-TLS client certificate private key file.It Fl \-sync
run non\-interactively to build cache by exploring bookmarks
.It Fl \-assume\-yes
@@ -65,6 +60,11 @@ depth of the cache to build.
Default is 1.
More is crazy.
Use at your own risks!
+.It Fl \-images-mode Ar IMAGES_MODE+the mode to use+to choose which images to download in a HTML page.+one of (None, readable, full).+Warning: full will slowdown your sync..It Fl \-cache\-validity Ar CACHE_VALIDITY
duration for which a cache is valid before sync (seconds)
.It Fl \-version
--
2.45.2
Signed-off-by: Étienne Mollier <emollier@debian.org>
---
man/opnk.1 | 29 ++++++++++++++---------------
1 file changed, 14 insertions(+), 15 deletions(-)
diff --git a/man/opnk.1 b/man/opnk.1
index 2b623be..5932998 100644
--- a/man/opnk.1+++ b/man/opnk.1
@@ -1,4 +1,4 @@
-.Dd August 27, 2023+.Dd November 25, 2024.Dt OPNK 1
.Os
.
@@ -8,26 +8,25 @@
.
.Sh SYNOPSIS
.Nm
+.Op \-mode Ar MODE+.Op \-cache-validity Ar CACHE_VALIDITY.Op Ar INPUT ...
.Nm
.Fl h | \-help
.
.Sh DESCRIPTION
-Opnk is the "universal open (like a punk)".-Opnk is a tool that will try to render any file or URL in the terminal,-using-.Xr netcache 1-and-.Xr ansicat 1 ,-and put them in-.Xr less 1 .-If that doesn’t work,-it will fallback to+opnk is an universal open command tool+that will try to display any file in the pager+.Xr less 1+after rendering its content with+.Xr ansicat 1 .+If that fails,+opnk will fallback to opening the file with.Xr xdg-open 1 .
-.Pp-.Xr Offpunk 1-is a command-line browser and feed reader dedicated to browsing the Web,-Gemini, Gopher and Spartan.+If given an URL as input instead of a path,+opnk will rely on+.Xr netcache 1+to get the networked content..Ss Positional arguments
.Bl -tag -width Ds -offset indent
.It Ar INPUT
--
2.45.2