maillinks 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d083333310f5787e778bb24a2532f2c9f284b2a1576c1c2db1942f3224bb738f
-  data.tar.gz: 27619b93b517807ad3b23eecc737bd830db63f0e98f721a9796a0f3c159403d7
+  metadata.gz: '097b42d44248b22bfedaa4bd1393bd1422607af0e3e18d6f87380c5dff149b18'
+  data.tar.gz: b1a42aaecec83dea60dd998e01e0ab1cbb6b09cbdfe79d1979da9f7e12b97fea
 SHA512:
-  metadata.gz: 240b806c7dd973e3fd7babe3caab44e132848a51f08a98ff1a821267f8de0654424ccc179cc762fb87f7d6afebd21cdf4a8faa0cc3a93811e273d5b91392963d
-  data.tar.gz: c8a5c84f1344f47cfd184e1712c32af6a1d21dfeca128846a58ef6b8ed441e8a5c56183e09ead59d06f6c3fff8a4b23d6c9189821dfddc3295cbcafed3817284
+  metadata.gz: '09c7aade1caafca6d93ecf9988f162a941acae1b28cb5e486f3c12faf2d5440abea816fb241b36de7ede8457b0c4e57fa8495d55e37c45d680c0dc1e23c10ea3'
+  data.tar.gz: b27765c032f3ffeff0f23bfab4814a9d6ab9f93fa82b8d3ed2cda67ad2a7766eb1039ae28d98fae4b137aae2f3f0d026fe154884cd8b80dd26f73129ceff9a9a

data/changes.txt

@@ -1,8 +1,19 @@
+v
+    -) The man page can be installed automatically, if the maillinks gem
+       is already installed on the current system. Initially call
+       gem manpages --update-all to ensure that the man pages for all
+       gems including such documentation is moved to the standard locations
+       on the system, also for the gems installed thereafter.
+
 v 1.1
     -) Bugfix: programming error corrected: :symbol.splt to :symbol.to_s.split
        The error only happens with invalid input files, the program will
        abort anyway.
 
+    -) The URLS of linked images are used as caption text in the list
+       of detected links. Previously, there had been no caption for 
+       linked images.
+
 v 1.0
     Browser is opened via Process::spawn().
 

data/doc/html/maillinks.html

@@ -47,6 +47,8 @@
 
       <blockquote>
         <p>cat [mail-file] | maillinks</p>
+
+        <p>maillinks &lt; [mail-file]</p>
       </blockquote>
     </section>
 
@@ -133,7 +135,7 @@
         <dt>Version</dt>
 
         <dd>
-          <p>0.2.1 (April 2026)</p>
+          <p>1.1 (September 2026)</p>
         </dd>
       </dl>
 
@@ -166,12 +168,25 @@
         "https://creativecommons.org/licenses/by-nd/4.0/">CC BY-ND
         4.0</a></p>
 
-        <p>Date: 2026-04-28</p>
+        <p>Date: 2026-09-22</p>
+
+        <p>The man page can be accessed in the ordinary way, by
+        executing <em>man</em> maillinks, <strong>if</strong> the
+        <a class="reference external" href=
+        "https://rubygems.org/gems/manpages">manpages</a> gem is
+        installed. Initially, executing <em>gem manpages
+        --update-all</em> will ensure that the man pages for all
+        packages which provide such documentation are copied to the
+        default locations for man pages.</p>
 
         <p><strong>Ω</strong>
         </p>
       </section>
     </section>
   </main>
+
+  <div id='page_dt'>
+    2026-09-22
+  </div>
 </body>
 </html>

data/doc/rst/maillinks.rst

@@ -15,6 +15,8 @@ or
 
   cat [mail-file] | maillinks
 
+  maillinks < [mail-file]
+
 Description
 ===========
 In a plain text email message, you will recognize URLs easily. In HTML-mails
@@ -74,7 +76,7 @@ Source-code and Development
   the data-archive with *tar -xzf*.
 
 Version
-  0.2.1 (April 2026)
+  1.1 (September 2026)
 
 .. _WTFPL: https://www.wtfpl.net/about/
 
@@ -88,6 +90,7 @@ This document
 -------------
 .. _CC By-ND 4.0: https://creativecommons.org/licenses/by-nd/4.0/
 .. |date| date::
+.. _manpages: https://rubygems.org/gems/manpages
 
 ©Michael Uplawski <michael.uplawski@uplawski.eu>
 
@@ -95,5 +98,10 @@ License: `CC BY-ND 4.0`_
 
 Date: |date|
 
+The man page can be accessed in the ordinary way, by executing *man*
+maillinks, **if** the `manpages`_ gem is installed. Initially, executing *gem
+manpages --update-all* will ensure that the man pages for all packages which
+provide such documentation are copied to the default locations for man pages.
+
 **Ω**
 

data/maillinks.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.description = "Marks in an email HTMl-links and creates a list of all links at the bottom of the mail-text. Best used with the Mutt MUA"
   s.authors     = AUTHORS
   s.email       = MAIL_ADDRESS
-  s.files  	=  %w~maillinks~.collect{|f| 'bin/' << f} + %w~constants.rb color_output.rb basic_logging.rb maillinks.rb ~.collect{|f| 'lib/' << f} + %w~html/maillinks.html man/maillinks.1.gz pdf/maillinks.pdf rst/maillinks.rst~.collect{|f| 'doc/' << f}  + %w~maillinks.gemspec changes.txt~.collect{|f|f}
+  s.files  	=  %w~maillinks~.collect{|f| 'bin/' << f} + %w~constants.rb color_output.rb basic_logging.rb maillinks.rb ~.collect{|f| 'lib/' << f} + %w~html/maillinks.html man/maillinks.1.gz pdf/maillinks.pdf rst/maillinks.rst~.collect{|f| 'doc/' << f}  + %w~maillinks.gemspec changes.txt man/maillinks.1~.collect{|f|f}
   s.homepage    = 'https://www.uplawski.eu/software'
   s.requirements = 'Linux, one of the browsers Dillo, W3M, Lynx, Brave-browser or Firefox'
   s.add_runtime_dependency 'nokogiri', '~> 1.19', '>= 1.19.0'
@@ -21,6 +21,6 @@ Gem::Specification.new do |s|
   s.metadata = {
     "homepage_uri" => 'https://www.uplawski.eu/software/',
     "documentation_uri" => 'https://www.uplawski.eu/software/maillinks/maillinks.html',
-    "changelog_uri" => 'https://www.uplawski.eu/software/changelogs/changes_maillinks.txt'
+    "changelog_uri" => 'https://www.uplawski.eu/software/maillinks/changes.txt'
   }
 end

data/man/maillinks.1

@@ -0,0 +1,131 @@
+.\" Man page generated from reStructuredText
+.\" by the Docutils 0.23 manpage writer.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH maillinks "1" "Tue 22 Sep 2026" "2.0" "General Commands"
+.SH Name
+Maillinks \- Print out the URLs of hyperlinks in HTML-mail.
+.SH Synopsis
+.INDENT 0.0
+.INDENT 3.5
+maillinks [mail\-file]
+.sp
+maillinks [mail\-file] <log level>
+.UNINDENT
+.UNINDENT
+.sp
+or
+.INDENT 0.0
+.INDENT 3.5
+cat [mail\-file] | maillinks
+.sp
+maillinks < [mail\-file]
+.UNINDENT
+.UNINDENT
+.SH Description
+.sp
+In a plain text email message, you will recognize URLs easily. In HTML\-mails
+they are most of the time part of a link\-tag and thus hidden by the caption
+text which is shown instead. Not only because, nowadays, UBE and UCE are
+composed with HTML, but in any case, before you take any risks, you should be
+aware of where the click on such a link will lead you. Hyperlinks may include
+directives which are likely to be addressed to a remotely running application.
+.sp
+\fIMaillinks\fP will find the URLs “behind” any hyperlink and show it in a footnote
+below the email\-text. You can scrutinize the URL and find information about the
+destination, before you engage your web\-browser or other tool to follow a link.
+.sp
+\fIMailLinks\fP displays the result, together with the original HTML\-mail in the
+first Web\-Browser that can be executed. At the time of this writing, the
+possible Browsers are: \fIDillo, W3M, Lynx, Brave\-Browser, Firefox\fP\&. If none of
+these is found, the program aborts with an error message.
+.SS Integration in mail\-clients
+.sp
+You can pipe in an email\-file to maillinks and thus create macros, where the
+functionality is present in a mail\-client.  In the Mutt user\-agent, to define a
+shortcut, you note the following lines in your .muttrc file:
+.INDENT 0.0
+.INDENT 3.5
+macro index M \(dq|maillinks \-\en\(dq          \(dqcreate link\-list\(dq
+.sp
+macro pager M \(dq|maillinks \-\en\(dq          \(dqcreate link\-list\(dq
+.UNINDENT
+.UNINDENT
+.sp
+Now you can push the \fIM\fP key either in the pager or in the mail index to pipe
+in a selected mail to maillinks.
+.sp
+Consult the documentation of your own mail\-client to find out if, and how
+macros or similar options can be configured.
+.SH Options
+.sp
+When called with a mail file as first argument, \fIMaillinks\fP can interpret
+as second argument a log level, to control the verboseness of the program
+output. The default is \fIinfo\fP, but you can have more detailed console output
+with \fIdebug\fP\&.
+.sp
+When used as a filter, reading from \fISTDIN\fP, \fBno additional arguments are
+accepted\fP\&.
+.SH Other Information
+.INDENT 0.0
+.TP
+.B Source\-code and Development
+\fIMaillinks\fP has been developed in Ruby and is published as a Ruby\-Gem. If you
+have installed the program from the Gem\-file, then, to access the
+source\-code, find Maillinks in the Gem\-directory for your Ruby\-version.
+All source\-files found are in the sub\-directories \fI/bin\fP and \fI/lib\fP\&.
+Alternatively, you can unpack the Gem\-file with \fItar \-xf\fP, then decompress
+the data\-archive with \fItar \-xzf\fP\&.
+.TP
+.B Version
+1.1 (September 2026)
+.UNINDENT
+.INDENT 0.0
+.TP
+.B License
+\fIMaillinks\fP is published under the conditions of the WTFPL \%<https://\:www\:.wtfpl\:.net/\:about/>, version 2.0.
+.TP
+.B Author
+Michael Uplawski <\%<michael\:.uplawski@\:uplawski\:.eu>>
+.UNINDENT
+.SS This document
+.sp
+©Michael Uplawski <\%<michael\:.uplawski@\:uplawski\:.eu>>
+.sp
+License: CC BY\-ND 4.0 \%<https://\:creativecommons\:.org/\:licenses/\:by-nd/\:4\:.0/>
+.sp
+Date: 2026\-09\-22
+.sp
+The man page can be accessed in the ordinary way, by executing \fIman\fP
+maillinks, \fBif\fP the manpages \%<https://\:rubygems\:.org/\:gems/\:manpages> gem is installed. Initially, executing \fIgem
+manpages \-\-update\-all\fP will ensure that the man pages for all packages which
+provide such documentation are copied to the default locations for man pages.
+.sp
+\fBΩ\fP
+.\" End of generated man page.

metadata

@@ -1,129 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: maillinks
 version: !ruby/object:Gem::Version
-  version: "1.1"
+  version: '1.2'
 platform: ruby
 authors:
-  - Michael Uplawski
+- Michael Uplawski
 bindir: bin
 cert_chain: []
-date: 2026-09-11 00:00:00.000000000 Z
+date: 2026-09-22 00:00:00.000000000 Z
 dependencies:
-  - !ruby/object:Gem::Dependency
-    name: nokogiri
-    requirement: !ruby/object:Gem::Requirement
-      requirements:
-        -
-          - ~>
-          - !ruby/object:Gem::Version
-            version: "1.19"
-        -
-          - ">="
-          - !ruby/object:Gem::Version
-            version: 1.19.0
-    type: :runtime
-    prerelease: false
-    version_requirements: !ruby/object:Gem::Requirement
-      requirements:
-        -
-          - ~>
-          - !ruby/object:Gem::Version
-            version: "1.19"
-        -
-          - ">="
-          - !ruby/object:Gem::Version
-            version: 1.19.0
-  - !ruby/object:Gem::Dependency
-    name: escape
-    requirement: !ruby/object:Gem::Requirement
-      requirements:
-        -
-          - ~>
-          - !ruby/object:Gem::Version
-            version: "0.0"
-        -
-          - ">="
-          - !ruby/object:Gem::Version
-            version: 0.0.4
-    type: :runtime
-    prerelease: false
-    version_requirements: !ruby/object:Gem::Requirement
-      requirements:
-        -
-          - ~>
-          - !ruby/object:Gem::Version
-            version: "0.0"
-        -
-          - ">="
-          - !ruby/object:Gem::Version
-            version: 0.0.4
-  - !ruby/object:Gem::Dependency
-    name: mail
-    requirement: !ruby/object:Gem::Requirement
-      requirements:
-        -
-          - ~>
-          - !ruby/object:Gem::Version
-            version: "2.9"
-        -
-          - ">="
-          - !ruby/object:Gem::Version
-            version: 2.9.0
-    type: :runtime
-    prerelease: false
-    version_requirements: !ruby/object:Gem::Requirement
-      requirements:
-        -
-          - ~>
-          - !ruby/object:Gem::Version
-            version: "2.9"
-        -
-          - ">="
-          - !ruby/object:Gem::Version
-            version: 2.9.0
-description: Marks in an email HTMl-links and creates a list of all links at the bottom of the mail-text. Best used with the Mutt MUA
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.19'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+- !ruby/object:Gem::Dependency
+  name: escape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: Marks in an email HTMl-links and creates a list of all links at the bottom
+  of the mail-text. Best used with the Mutt MUA
 email: michael.uplawski@uplawski.eu
 executables:
-  - maillinks
+- maillinks
 extensions: []
 extra_rdoc_files: []
 files:
-  - bin/maillinks
-  - changes.txt
-  - doc/html/maillinks.html
-  - doc/man/maillinks.1.gz
-  - doc/pdf/maillinks.pdf
-  - doc/rst/maillinks.rst
-  - lib/basic_logging.rb
-  - lib/color_output.rb
-  - lib/constants.rb
-  - lib/maillinks.rb
-  - maillinks.gemspec
-homepage: "https://www.uplawski.eu/software"
+- bin/maillinks
+- changes.txt
+- doc/html/maillinks.html
+- doc/man/maillinks.1.gz
+- doc/pdf/maillinks.pdf
+- doc/rst/maillinks.rst
+- lib/basic_logging.rb
+- lib/color_output.rb
+- lib/constants.rb
+- lib/maillinks.rb
+- maillinks.gemspec
+- man/maillinks.1
+homepage: https://www.uplawski.eu/software
 licenses:
-  - WTFPL
+- WTFPL
 metadata:
-  homepage_uri: "https://www.uplawski.eu/software/"
-  documentation_uri: "https://www.uplawski.eu/software/maillinks/maillinks.html"
-  changelog_uri: "https://www.uplawski.eu/software/changelogs/changes_maillinks.txt"
+  homepage_uri: https://www.uplawski.eu/software/
+  documentation_uri: https://www.uplawski.eu/software/maillinks/maillinks.html
+  changelog_uri: https://www.uplawski.eu/software/maillinks/changes.txt
 rdoc_options: []
 require_paths:
-  - lib
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-    -
-      - ">="
-      - !ruby/object:Gem::Version
-        version: "4.0"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-    -
-      - ">="
-      - !ruby/object:Gem::Version
-        version: "0"
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements:
-  - "Linux, one of the browsers Dillo, W3M, Lynx, Brave-browser or Firefox"
-rubygems_version: 4.1.0.beta1
+- Linux, one of the browsers Dillo, W3M, Lynx, Brave-browser or Firefox
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Documentation in HTML formatted. Alternative Browsers allowed.
 test_files: []