Changeset 147 in code for trunk/yukari.1

Timestamp:

Mar 18, 2024, 1:23:54 AM (15 months ago)

Author:

Izuru Yakumo

Message:

コードのリファクタリングが完了しました

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>

File:

• trunk/yukari.1 (modified) (1 diff)

trunk/yukari.1

@@ -1 @@
-.TH MORTY "1" "2018" "yukari" "User Commands"
-.SH NAME
-yukari \- Privacy aware web content sanitizer proxy as a service
-.SH SYNOPSIS
-.B yukari
-.RI [ OPTIONS ]
-.br
-.SH DESCRIPTION
-Yukari rewrites web pages to exclude malicious HTML tags and attributes. It
-also replaces external resource references to prevent third party
+.Dd $Mdocdate$
+.Dt YUKARI 1
+.Os
+.Sh NAME
+.Nm yukari
+.Nd Privacy-aware Web Content Sanitizer Proxy As A Service (WCSPAAS)
+.Sh SYNOPSIS
+.Nm
+.Op Fl f Ar string
+.Op Fl proxy Ar string
+.Op Fl proxyenv Ar bool
+.Op Fl socks5 Ar string
+.Op Fl version
+.Sh DESCRIPTION
+Yukari's Gap rewrites web pages to exclude malicious HTML tags and attributes.
+It also replaces external resource references in order to prevent third-party
 information leaks.
-.sp
-The main goal of yukari is to provide a result proxy for searx, but it can be
-used as a standalone sanitizer service too.
-.SH OPTIONS
-.HP
-\fB\-ipv6\fR
-.IP
-Allow IPv6 HTTP requests
-.HP
-\fB\-key\fR string
-.IP
-HMAC url validation key (hexadecimal encoded) \- leave blank to disable
-.HP
-\fB\-listen\fR string
-.IP
-Listen address (default "127.0.0.1:3000")
-.HP
-\fB\-timeout\fR uint
-.IP
-Request timeout (default 2)
-.HP
-\fB\-version\fR
-.IP
-Show version
-.SH BUGS
-Bugs or suggestions? Visit the issue tracker at
-https://git.chaotic.ninja/yakumo.izuru/yukari/issues.
-.SH SEE ALSO
-.BR searx (1)
-.SH LICENSE
-Copyright 2023-present Izuru Yakumo <yakumo.izuru@chaotic.ninja>
-.br
-Copyright 2016-2018 Adam Tauber <asciimoo@gmail.com>
-.br
-Copyright 2016 Alexandre Flament <alex@al-f.net>
-.sp
-This program is free software: you can redistribute it and/or modify it under
-the terms of the GNU Affero General Public License as published by the Free
-Software Foundation, either version 3 of the License, or (at your option) any
-later version.
-.sp
+.Pp
+The main goal of Yukari's Gap is to provide a result proxy for SearX, but it
+can be used as a standalone sanitizer service, too.
+.Sh OPTIONS
+.Bl -tag -width Ds
+.It Fl f Ar path
+Load configuration file from path
+.It Fl proxy Ar string
+Use the specified HTTP proxy (ie: [user:pass@]hostname:port),
+this overrides the
+.Fl socks5
+option and the IPv6 setting
+.It Fl proxyenv Ar bool
+Use a HTTP proxy as set in the environment (such as
+.Ev HTTP_PROXY ,
+.Ev HTTPS_PROXY ,
+.Ev NO_PROXY
+).
+Overrides the
+.Fl proxy ,
+.Fl socks5 ,
+flags and the IPv6 setting
+.It Fl socks5 Ar string
+Use a SOCKS5 proxy (ie: hostname:port), this
+overrides the IPv6 setting
+.El
+.Sh SEE ALSO
+.Xr SearX 1
+.Sh AUTHORS
+.An Adam Tauber Aq Mt asciimoo@gmail.com
+.An Alexandre Flament Aq Mt alex@al-f.net
+.Sh MAINTAINERS
+.An Izuru Yakumo Aq Mt yakumo.izuru@chaotic.ninja
+.Sh BUGS
+Bugs or suggestions?
+Send an email to
+.Aq Mt yukari-dev@chaotic.ninja
+.Sh LICENSE
+This program is free software: you can redistribute it and/or modify it
+under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+.Pp
 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 Affero General Public License for more
-details.
-.sp
-You should have received a copy of the GNU Affero General Public License along
-with this program. If not, see <http://www.gnu.org/licenses/>.
+PARTICULAR PURPOSE.
+See the GNU Affero General Public License for more details.