docs/_optionsall: new page

A version of optionswhen but the list is sorted on the option name Closes #306
curl · Oct 9, 2023 · 162169f · 162169f
1 parent a8de89b
commit 162169f
Show file tree

Hide file tree

Showing 4 changed files with 109 additions and 0 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -195,6 +195,7 @@ PAGES = \
  tutorial.html \
  mk-ca-bundle.html \
  mqtt.html \
+ optionsall.html \
  optionswhen.html \
  projdocs.html \
  protdocs.html \
@@ -265,6 +266,12 @@ optionswhen.html: _optionswhen.html optionswhen.gen
 optionswhen.gen: $(DOCROOT)/options-in-versions optionswhen.pl
 	./optionswhen.pl $< > $@
 
+optionsall.html: _optionsall.html optionsall.gen
+	$(ACTION)
+
+optionsall.gen: $(DOCROOT)/options-in-versions alloptions.pl
+	./alloptions.pl $< > $@
+
 curl.1: ../cvssource/docs/cmdline-opts/*.d
 	(cd ../cvssource/docs/cmdline-opts && perl gen.pl mainpage *.d) > curl.1
 

diff --git a/docs/_optionsall.html b/docs/_optionsall.html
@@ -0,0 +1,37 @@
+#include "_doctype.html"
+<html>
+<head> <title>curl - When command line options were introduced</title>
+#include "css.t"
+#include "manpage.t"
+</head>
+
+#define CURL_DOCS
+#define DOCS_MANPAGE
+#define TOOL_DOCS
+#define CURL_URL docs/optionswhen.html
+
+#include "_menu.html"
+#include "setup.t"
+
+WHERE3(Docs, "/docs/", Tool, "/docs/tooldocs.html", Options when)
+TITLE(When command line options were introduced)
+<div class="relatedbox">
+<b>Related:</b>
+<br><a href="faq.html">FAQ</a>
+<br><a href="httpscripting.html">HTTP Scripting</a>
+<br><a href="manpage.html">Man page</a>
+</div>
+
+curl is continuously developed and new command line options are added over
+time. This list shows which options that were added in which version.
+
+<p>
+[<b> <a href="optionswhen.html">sort on version</a> | <b>sort on option name</b> ]
+<p>
+
+#include "optionsall.gen"
+
+#include "_footer.html"
+
+</body>
+</html>
diff --git a/docs/_optionswhen.html b/docs/_optionswhen.html
@@ -25,6 +25,8 @@
 curl is continuously developed and new command line options are added over
 time. This list shows which options that were added in which version.
 
+<p>
+[<b> sort on version</b> | <a href="optionsall.html">sort on option name</a> ]
 <p>
 
 #include "optionswhen.gen"

diff --git a/docs/alloptions.pl b/docs/alloptions.pl
@@ -0,0 +1,63 @@
+#!/usr/bin/perl
+#***************************************************************************
+#                                  _   _ ____  _
+#  Project                     ___| | | |  _ \| |
+#                             / __| | | | |_) | |
+#                            | (__| |_| |  _ <| |___
+#                             \___|\___/|_| \_\_____|
+#
+# Copyright (C) Daniel Stenberg, <[email protected]>, et al.
+#
+# This software is licensed as described in the file COPYING, which
+# you should have received as part of this distribution. The terms
+# are also available at https://curl.se/docs/copyright.html.
+#
+# You may opt to use, copy, modify, merge, publish, distribute and/or sell
+# copies of the Software, and permit persons to whom the Software is
+# furnished to do so, under the terms of the COPYING file.
+#
+# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
+# KIND, either express or implied.
+#
+# SPDX-License-Identifier: curl
+#
+###########################################################################
+
+# options-in-versions
+my $oinv = $ARGV[0];
+
+my $html = "manpage.html";
+my $changelog = "/changes.html";
+
+my %vers;
+open(O, "<$oinv");
+while(<O>) {
+    if($_ =~ /^(\S+) (\((.*)\)|) +([0-9.]+)/) {
+        my ($long, $sh, $version) = ($1, $3, $4);
+        $added{$long} = $version;
+        $short{$long} = $sh;
+    }
+}
+
+sub verlink {
+    my ($ver)= @_;
+    $ver =~ s/\./_/g;
+    return $ver;
+}
+
+sub manlink {
+    my ($long)= @_;
+    if($short{$long}) {
+        return $short{$long};
+    }
+    return $long;
+}
+
+print "<table>\n";
+for my $long (sort {lc($a) cmp lc($b) } keys %short) {
+    my $v = $added{$long};
+    printf "<tr><td><a href=\"manpage.html#%s\">$long</a></td><td><a href=\"%s#%s\">$v</a></td></tr>\n",
+        manlink($long),
+        $changelog, verlink($v);
+}
+print "</table>\n";