Skip to content
This repository has been archived by the owner on Apr 12, 2022. It is now read-only.

Commit

Permalink
Add help, manual, version options
Browse files Browse the repository at this point in the history
  • Loading branch information
@anyicomplex
anyicomplex committed Feb 19, 2022
1 parent 25de531 commit 36a0928
Show file tree
Hide file tree
Showing 65 changed files with 2,973 additions and 550 deletions.
3 changes: 2 additions & 1 deletion build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@ plugins {
}

group 'io.github.anyicomplex'
version '1.1.3-rc1'
version '1.1.3-rc2'

sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
mavenCentral()
Expand Down
6 changes: 4 additions & 2 deletions docs/allclasses-frame.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_312) on Tue Feb 15 16:40:03 EST 2022 -->
<!-- Generated by javadoc (1.8.0_312) on Sat Feb 19 18:03:35 EST 2022 -->
<title>All Classes</title>
<meta name="date" content="2022-02-15">
<meta name="date" content="2022-02-19">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -27,7 +27,9 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/anyicomplex/xdg/utils/XDGMime.Option.html" title="class in com.anyicomplex.xdg.utils" target="classFrame">XDGMime.Option</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGMime.Subcommand.html" title="class in com.anyicomplex.xdg.utils" target="classFrame">XDGMime.Subcommand</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGOpen.html" title="class in com.anyicomplex.xdg.utils" target="classFrame">XDGOpen</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGOpen.Option.html" title="class in com.anyicomplex.xdg.utils" target="classFrame">XDGOpen.Option</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGScreenSaver.html" title="class in com.anyicomplex.xdg.utils" target="classFrame">XDGScreenSaver</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGScreenSaver.Option.html" title="class in com.anyicomplex.xdg.utils" target="classFrame">XDGScreenSaver.Option</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGScreenSaver.Subcommand.html" title="class in com.anyicomplex.xdg.utils" target="classFrame">XDGScreenSaver.Subcommand</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGSettings.html" title="class in com.anyicomplex.xdg.utils" target="classFrame">XDGSettings</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGSettings.Option.html" title="class in com.anyicomplex.xdg.utils" target="classFrame">XDGSettings.Option</a></li>
Expand Down
6 changes: 4 additions & 2 deletions docs/allclasses-noframe.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_312) on Tue Feb 15 16:40:03 EST 2022 -->
<!-- Generated by javadoc (1.8.0_312) on Sat Feb 19 18:03:35 EST 2022 -->
<title>All Classes</title>
<meta name="date" content="2022-02-15">
<meta name="date" content="2022-02-19">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
Expand All @@ -27,7 +27,9 @@ <h1 class="bar">All&nbsp;Classes</h1>
<li><a href="com/anyicomplex/xdg/utils/XDGMime.Option.html" title="class in com.anyicomplex.xdg.utils">XDGMime.Option</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGMime.Subcommand.html" title="class in com.anyicomplex.xdg.utils">XDGMime.Subcommand</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGOpen.html" title="class in com.anyicomplex.xdg.utils">XDGOpen</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGOpen.Option.html" title="class in com.anyicomplex.xdg.utils">XDGOpen.Option</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGScreenSaver.html" title="class in com.anyicomplex.xdg.utils">XDGScreenSaver</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGScreenSaver.Option.html" title="class in com.anyicomplex.xdg.utils">XDGScreenSaver.Option</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGScreenSaver.Subcommand.html" title="class in com.anyicomplex.xdg.utils">XDGScreenSaver.Subcommand</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGSettings.html" title="class in com.anyicomplex.xdg.utils">XDGSettings</a></li>
<li><a href="com/anyicomplex/xdg/utils/XDGSettings.Option.html" title="class in com.anyicomplex.xdg.utils">XDGSettings.Option</a></li>
Expand Down
66 changes: 63 additions & 3 deletions docs/com/anyicomplex/xdg/utils/XDGDesktopIcon.Option.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_312) on Tue Feb 15 16:40:02 EST 2022 -->
<!-- Generated by javadoc (1.8.0_312) on Sat Feb 19 18:03:35 EST 2022 -->
<title>XDGDesktopIcon.Option</title>
<meta name="date" content="2022-02-15">
<meta name="date" content="2022-02-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -128,11 +128,29 @@ <h3>Field Summary</h3>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopIcon.Option.html#HELP">HELP</a></span></code>
<div class="block">Output command synopsis.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopIcon.Option.html#MANUAL">MANUAL</a></span></code>
<div class="block">Output manual page.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopIcon.Option.html#NOVENDOR">NOVENDOR</a></span></code>
<div class="block">Normally, xdg-desktop-icon checks to ensure that a<br>
*.desktop file to be installed has a vendor prefix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopIcon.Option.html#VERSION">VERSION</a></span></code>
<div class="block">Output the version information.</div>
</td>
</tr>
</table>
</li>
</ul>
Expand Down Expand Up @@ -166,7 +184,7 @@ <h3>Field Detail</h3>
<a name="NOVENDOR">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>NOVENDOR</h4>
<pre>public static final&nbsp;java.lang.String NOVENDOR</pre>
Expand All @@ -186,6 +204,48 @@ <h4>NOVENDOR</h4>
</dl>
</li>
</ul>
<a name="HELP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HELP</h4>
<pre>public static final&nbsp;java.lang.String HELP</pre>
<div class="block">Output command synopsis.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.anyicomplex.xdg.utils.XDGDesktopIcon.Option.HELP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MANUAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MANUAL</h4>
<pre>public static final&nbsp;java.lang.String MANUAL</pre>
<div class="block">Output manual page.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.anyicomplex.xdg.utils.XDGDesktopIcon.Option.MANUAL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VERSION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VERSION</h4>
<pre>public static final&nbsp;java.lang.String VERSION</pre>
<div class="block">Output the version information.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.anyicomplex.xdg.utils.XDGDesktopIcon.Option.VERSION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
4 changes: 2 additions & 2 deletions docs/com/anyicomplex/xdg/utils/XDGDesktopIcon.Subcommand.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_312) on Tue Feb 15 16:40:02 EST 2022 -->
<!-- Generated by javadoc (1.8.0_312) on Sat Feb 19 18:03:35 EST 2022 -->
<title>XDGDesktopIcon.Subcommand</title>
<meta name="date" content="2022-02-15">
<meta name="date" content="2022-02-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down
82 changes: 77 additions & 5 deletions docs/com/anyicomplex/xdg/utils/XDGDesktopIcon.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_312) on Tue Feb 15 16:40:02 EST 2022 -->
<!-- Generated by javadoc (1.8.0_312) on Sat Feb 19 18:03:35 EST 2022 -->
<title>XDGDesktopIcon</title>
<meta name="date" content="2022-02-15">
<meta name="date" content="2022-02-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand All @@ -18,7 +18,7 @@
catch(err) {
}
//-->
var methods = {"i0":9,"i1":9,"i2":9};
var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
Expand Down Expand Up @@ -262,19 +262,37 @@ <h3>Method Summary</h3>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopIcon.html#help-java.lang.StringBuilder-">help</a></span>(java.lang.StringBuilder&nbsp;output)</code>
<div class="block">Output command synopsis.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopIcon.html#install-java.lang.StringBuilder-java.lang.Boolean-java.lang.String-">install</a></span>(java.lang.StringBuilder&nbsp;output,
java.lang.Boolean&nbsp;novendor,
java.lang.String&nbsp;FILE)</code>
<div class="block">Installs FILE to the desktop of the current user.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<tr id="i3" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopIcon.html#manual-java.lang.StringBuilder-">manual</a></span>(java.lang.StringBuilder&nbsp;output)</code>
<div class="block">Output manual page.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopIcon.html#uninstall-java.lang.StringBuilder-java.lang.String-">uninstall</a></span>(java.lang.StringBuilder&nbsp;output,
java.lang.String&nbsp;FILE)</code>
<div class="block">Removes FILE from the desktop of the current user.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopIcon.html#version-java.lang.StringBuilder-">version</a></span>(java.lang.StringBuilder&nbsp;output)</code>
<div class="block">Output the version information.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
Expand Down Expand Up @@ -360,7 +378,7 @@ <h4>install</h4>
<a name="uninstall-java.lang.StringBuilder-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>uninstall</h4>
<pre>public static&nbsp;int&nbsp;uninstall(java.lang.StringBuilder&nbsp;output,
Expand All @@ -377,6 +395,60 @@ <h4>uninstall</h4>
</dl>
</li>
</ul>
<a name="help-java.lang.StringBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>help</h4>
<pre>public static&nbsp;int&nbsp;help(java.lang.StringBuilder&nbsp;output)</pre>
<div class="block">Output command synopsis.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>output</code> - the output buffer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the exit code</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/anyicomplex/xdg/utils/XDGUtils.ExitCode.html" title="class in com.anyicomplex.xdg.utils"><code>XDGUtils.ExitCode</code></a></dd>
</dl>
</li>
</ul>
<a name="manual-java.lang.StringBuilder-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>manual</h4>
<pre>public static&nbsp;int&nbsp;manual(java.lang.StringBuilder&nbsp;output)</pre>
<div class="block">Output manual page.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>output</code> - the output buffer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the exit code</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/anyicomplex/xdg/utils/XDGUtils.ExitCode.html" title="class in com.anyicomplex.xdg.utils"><code>XDGUtils.ExitCode</code></a></dd>
</dl>
</li>
</ul>
<a name="version-java.lang.StringBuilder-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>version</h4>
<pre>public static&nbsp;int&nbsp;version(java.lang.StringBuilder&nbsp;output)</pre>
<div class="block">Output the version information.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>output</code> - the output buffer</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the exit code</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../com/anyicomplex/xdg/utils/XDGUtils.ExitCode.html" title="class in com.anyicomplex.xdg.utils"><code>XDGUtils.ExitCode</code></a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
66 changes: 63 additions & 3 deletions docs/com/anyicomplex/xdg/utils/XDGDesktopMenu.Option.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_312) on Tue Feb 15 16:40:02 EST 2022 -->
<!-- Generated by javadoc (1.8.0_312) on Sat Feb 19 18:03:35 EST 2022 -->
<title>XDGDesktopMenu.Option</title>
<meta name="date" content="2022-02-15">
<meta name="date" content="2022-02-19">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
Expand Down Expand Up @@ -128,6 +128,18 @@ <h3>Field Summary</h3>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopMenu.Option.html#HELP">HELP</a></span></code>
<div class="block">Output command synopsis.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopMenu.Option.html#MANUAL">MANUAL</a></span></code>
<div class="block">Output manual page.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopMenu.Option.html#MODE">MODE</a></span></code>
<div class="block">mode can be user or system.</div>
</td>
Expand All @@ -146,6 +158,12 @@ <h3>Field Summary</h3>
vendor prefix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/anyicomplex/xdg/utils/XDGDesktopMenu.Option.html#VERSION">VERSION</a></span></code>
<div class="block">Output the version information.</div>
</td>
</tr>
</table>
</li>
</ul>
Expand Down Expand Up @@ -221,7 +239,7 @@ <h4>NOVENDOR</h4>
<a name="MODE">
<!-- -->
</a>
<ul class="blockListLast">
<ul class="blockList">
<li class="blockList">
<h4>MODE</h4>
<pre>public static final&nbsp;java.lang.String MODE</pre>
Expand All @@ -238,6 +256,48 @@ <h4>MODE</h4>
</dl>
</li>
</ul>
<a name="HELP">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>HELP</h4>
<pre>public static final&nbsp;java.lang.String HELP</pre>
<div class="block">Output command synopsis.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.anyicomplex.xdg.utils.XDGDesktopMenu.Option.HELP">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="MANUAL">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MANUAL</h4>
<pre>public static final&nbsp;java.lang.String MANUAL</pre>
<div class="block">Output manual page.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.anyicomplex.xdg.utils.XDGDesktopMenu.Option.MANUAL">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="VERSION">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VERSION</h4>
<pre>public static final&nbsp;java.lang.String VERSION</pre>
<div class="block">Output the version information.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../constant-values.html#com.anyicomplex.xdg.utils.XDGDesktopMenu.Option.VERSION">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
Expand Down
Loading

0 comments on commit 36a0928

Please sign in to comment.