1
0
mirror of https://github.com/NLnetLabs/routinator.git synced 2024-05-19 06:50:04 +00:00
nlnetlabs-routinator/doc/routinator.1
Martin Hoffmann 936fe1a0ba Running forever.
2018-09-25 10:12:44 +02:00

126 lines
2.6 KiB
Groff

.TH "routinator" "1" "July 31, 2018" "NLnet Labs" "routinator 0.1.0
.\"
.\" routinator.1 -- routinator DNS lookup utility
.\"
.\" Copyright (c) 2018, NLnet Labs. All rights reserved.
.\"
.\" See LICENSE for the license.
.\"
.\" Provicial manual page, need improvement so
.\" version etc is generated automagically
.\"
.SH "NAME"
.B routinator
\- Experimental RPKI relying party software
.SH "SYNOPSIS"
.B routinator
.RB [ \-h | \c
.BR \-\-help ]
.RB [ \-N | \c
.BR \-\-noprocess
.RB [ \-\-strict ]
.RB [ \-V | \c
.BR \-\-Version ]
.RB [ \-v | \c
.BR \-\-verbose ]
.RB [ \-c | \c
.BR \-\-cache ]
.IR cache
.RB [ \-f | \c
.BR \-\-outform ]
.IR format
.RB [ \-o | \c
.BR \-\-output ]
.RI [ file ]
.SH "DESCRIPTION"
.B Routinator
validates RPKI route origin attestations.
.P
The available options are:
.TP
.BR \-h , " \-\-help"
Print some help information.
.TP
.BR \-N , " \-\-noprocess
Do not process the repository.
.TP
.BR \-n , " \-\-noupdate
Do not update the local cache.
.TP
.B \-\-strict
Parse RPKI data in strict mode.
.TP
.BR \-V , " \-\-version
Print version information.
.TP
.BR \-v , " \-\-verbose
Print more information.
If given multiple times, more information is
printed.
.TP
.BR \-c , " \-\-cache \fIdirectory
Sets the cache directory.
Defaults to a directory called
.I rpki\-cache
in the current directory.
The directory has to be created by the user.
.TP
.BR \-x , " \-\-exceptions \fIfile
Path to a file that contains the local exceptions.
The file must be in SLURM format as defined in RFC 8416.
.TP
.BR \-f , " \-\-outform
Specifies which output format to use.
Possible formats are
.IR csv ,
.IR json ,
.IR rpsl
and
.IR none .
Default format is
.IR csv .
.TP
.BR \-o , " \-\-ouput \fIfilename
The output file to be used.
If no output filename or the target "-" is given, standard output is used.
.SH CACHE DIRECTORY STRUCTURE
.\" This description is actually something that should
.\" be covered by a reference manual.
The
.B
Routinator
uses the
.UX
file sytem as cache for the data.
The default cache is the
.I rpki-cache
directory in the folder where the program is called.
This directory should have two entries,
.IR tal
and
.IR repository .
The
.I tal
directoriy contains the
.I registry.tal
files which instruct the
.B routinator
on which RIR repositories to download validation data from, while the
.I repository
directory is used for storage.
.P
It is beyond the scope of this manual page
to descibe the format of the
.I \&.tal
or the repository data.
.SH AUTHOR
.P
Jaap Akkerhuis whipped up this manual page.
.SH "EXIT CODE"
The routinator program exits with status code 1 on error,
.SH "SEE ALSO"
.P
Reference manual (to be written).
.SH BUGS
Sure