File: openk.1

package info (click to toggle)
offpunk 3.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 2,012 kB
  • sloc: python: 6,263; sh: 117; makefile: 2
file content (63 lines) | stat: -rw-r--r-- 1,397 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.Dd November 25, 2024
.Dt OPNK 1
.Os 
.
.Sh NAME
.Nm openk
.Nd universal open (like a punk) for offpunk
.
.Sh SYNOPSIS
.Nm
.Op \-mode Ar MODE
.Op \-linkmode Ar LINKMODE
.Op \-cache-validity Ar CACHE_VALIDITY
.Op Ar INPUT ...
.Nm
.Fl h | \-help
.
.Sh DESCRIPTION
openk 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,
openk will fallback to opening the file with
.Xr xdg-open 1 .
If given an URL as input instead of a path,
openk will rely on
.Xr netcache 1
to get the networked content.
.Ss Positional arguments
.Bl -tag -width Ds -offset indent
.It Ar INPUT
path to the file or URL to open.
.El
.Ss Keyword arguments
.Bl -tag -width Ds -offset indent
.It Fl h , \-help
Show a help message and exit
.It Fl \-mode Ar MODE
MODE to use to render to choose between normal (default), full or source
.It Fl \-linkmode Ar LINKMODE
LINKMODE to use to render links. Available are
.Ic none
(default) and
.Ic end .
This option will not effect render mode source.
.It Fl \-cache-validity CACHE_VALIDITY
Maximum age (in second) of the cached version before redownloading a new version.
.El
.
.Sh EXIT STATUS
.Ex -std
.
.Sh SEE ALSO
.Xr ansicat 1 ,
.Xr migrate-offpunk-cache 1 ,
.Xr netcache 1 ,
.Xr offpunk 1 ,
.Lk https://offpunk.net/
.
.Sh AUTHORS
.An Lionel Dricot (Ploum) Aq Mt offpunk2 at ploum.eu