diff options
| -rw-r--r-- | README | 77 | ||||
| -rw-r--r-- | README.adoc | 107 | ||||
| -rw-r--r-- | README.adoc.license | 2 | ||||
| -rw-r--r-- | jarink.go | 2 |
4 files changed, 110 insertions, 78 deletions
@@ -1,77 +0,0 @@ -= Jarink - -Jarink is a program to help web administrator and developers to inspect -and maintains their website. - -== Synopsis - - jarink [OPTIONS] <COMMAND> <args...> - -Available command, - - brokenlinks - scan the website for broken links (page and images). - help - print the usage of the command. - -== Usage - -[OPTIONS] brokenlinks <URL> - - Scan for broken links on the web server pointed by URL. - Links will be scanned on anchor href attribute ("<a href=...>") or - on the image src attribute ("<img src=..."). - - The URL can be start from base or from sub path. - Scanning from path only report brokenlinks on that path and their - sub paths. - - Once finished it will print the page and list of broken links in - JSON format to standard output, - - { - "$PAGE": [{ - "link": <string>, - "error": <string>, - "code": <integer> - }, - ... - ], - ... - } - - This command accept the following options, - - -verbose - - Print the page that being scanned to standard error. - - -past-result=<path to JSON file> - - Scan only the pages reported by result from past scan based - on the content in JSON file. This minimize the time to - re-scan the pages once we have fixed the URLs. - - For example, given a website that have the following pages, - - - web.tld (base) - - web.tld/page1 - - web.tld/page1/sub1 - - web.tld/page2 - - web.tld/page2/sub1 - - Invoking brokenlinks with - - $ jarink brokenlinks https://web.tld - - will scan all of the pages, but invoking brokenlinks on path - "/page2" - - $ jarink brokenlinks https://web.tld/page2 - - only scan "/page2" and "/page2/sub1". - - -== Notes - -jarink version 0.1.0. - -Source code - https://git.sr.ht/~shulhan/jarink diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..fc7ea3b --- /dev/null +++ b/README.adoc @@ -0,0 +1,107 @@ += Jarink +:sectanchors: +:toc: + +Jarink is a program to help web administrator and developers to inspect +and maintains their website. + +== Synopsis + + jarink [OPTIONS] <COMMAND> <args...> + +Available command, + + brokenlinks - scan the website for broken links (page and images). + help - print the usage of the command. + +== Usage + +=== brokenlinks command + + [OPTIONS] brokenlinks <URL> + +Scan for broken links on the web server pointed by URL. +Links will be scanned on anchor href attribute ("<a href=...>") or +on the image src attribute ("<img src=..."). + +The URL can be start from base or from sub path. +Scanning from path only report brokenlinks on that path and their +sub paths. + +Once finished it will print the page and list of broken links in +JSON format to standard output, + +---- +{ + "$PAGE": [{ + "link": <string>, + "error": <string>, + "code": <integer> + }, + ... + ], + ... +} +---- + +This command accept the following options, + +`-verbose`:: +Print the page that being scanned to standard error. + +`-past-result=<path to JSON file>`:: +Scan only the pages reported by result from past scan based +on the content in JSON file. +This minimize the time to re-scan the pages once we have fixed the URLs. + + +== Examples + +Given a website that have the following pages, + +- web.tld (base) +- web.tld/page1 +- web.tld/page1/sub1 +- web.tld/page2 +- web.tld/page2/sub1 + + +The following command will scan all of the pages in the website web.tld. + +---- +$ jarink brokenlinks https://web.tld +---- + +Invoking brokenlinks on path "/page2" only scan "/page2" and "/page2/sub1". + +---- +$ jarink brokenlinks https://web.tld/page2 +---- + + +== Notes + +jarink version 0.1.0. + +Source code - https://git.sr.ht/~shulhan/jarink + + +== License + +This software is licensed under GPL 3.0. + +Copyright 2025 Shulhan <ms@kilabit.info> + +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the Free +Software Foundation, either version 3 of the License, or (at your option) +any later version. + +This program is distributed in the hope that it will be useful, but WITHOUT +ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. +See the GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along with +this program. +If not, see <http://www.gnu.org/licenses/>. diff --git a/README.adoc.license b/README.adoc.license new file mode 100644 index 0000000..22616a9 --- /dev/null +++ b/README.adoc.license @@ -0,0 +1,2 @@ +SPDX-FileCopyrightText: 2025 M. Shulhan <ms@kilabit.info> +SPDX-License-Identifier: GPL-3.0-only @@ -7,5 +7,5 @@ import ( _ "embed" ) -//go:embed README +//go:embed README.adoc var GoEmbedReadme string |