summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRuss Allbery <eagle@eyrie.org>2018-05-05 13:33:54 -0700
committerRuss Allbery <eagle@eyrie.org>2018-05-05 13:33:54 -0700
commita44706681f19d3209f79d059060ca3003db27e4f (patch)
tree998520c772c87ce7d531e0b37535857355ddb43c /docs
parentea426fbf4800ff010b354d247fd185fd6a686d6d (diff)
parent7989cf47a1dab0c0eb54410cb217316196f8f37b (diff)
New upstream version 3.15
Diffstat (limited to 'docs')
-rw-r--r--docs/api/remctl.310
-rw-r--r--docs/api/remctl.pod10
-rw-r--r--docs/api/remctl_close.36
-rw-r--r--docs/api/remctl_close.pod6
-rw-r--r--docs/api/remctl_command.36
-rw-r--r--docs/api/remctl_command.pod7
-rw-r--r--docs/api/remctl_error.36
-rw-r--r--docs/api/remctl_error.pod6
-rw-r--r--docs/api/remctl_new.36
-rw-r--r--docs/api/remctl_new.pod6
-rw-r--r--docs/api/remctl_noop.36
-rw-r--r--docs/api/remctl_noop.pod6
-rw-r--r--docs/api/remctl_open.310
-rw-r--r--docs/api/remctl_open.pod9
-rw-r--r--docs/api/remctl_output.320
-rw-r--r--docs/api/remctl_output.pod22
-rw-r--r--docs/api/remctl_set_ccache.38
-rw-r--r--docs/api/remctl_set_ccache.pod9
-rw-r--r--docs/api/remctl_set_source_ip.36
-rw-r--r--docs/api/remctl_set_source_ip.pod5
-rw-r--r--docs/api/remctl_set_timeout.36
-rw-r--r--docs/api/remctl_set_timeout.pod6
-rw-r--r--docs/design.html2
-rw-r--r--docs/extending2
-rw-r--r--docs/metadata/README6
-rw-r--r--docs/metadata/blurb6
-rw-r--r--docs/metadata/bootstrap2
-rw-r--r--docs/metadata/build/middle72
-rw-r--r--docs/metadata/description49
-rw-r--r--docs/metadata/metadata.json169
-rw-r--r--docs/metadata/quote1
-rw-r--r--docs/metadata/requirements52
-rw-r--r--docs/metadata/sections/building-on-windows31
-rw-r--r--docs/metadata/test/prefix10
-rw-r--r--docs/metadata/test/suffix27
-rw-r--r--docs/protocol-v42
-rw-r--r--docs/protocol.html19
-rw-r--r--docs/protocol.txt16
-rw-r--r--docs/protocol.xml15
-rw-r--r--docs/remctl-shell.8.in6
-rw-r--r--docs/remctl-shell.pod5
-rw-r--r--docs/remctl.110
-rw-r--r--docs/remctl.pod9
-rw-r--r--docs/remctld.8.in10
-rw-r--r--docs/remctld.pod9
45 files changed, 601 insertions, 111 deletions
diff --git a/docs/api/remctl.3 b/docs/api/remctl.3
index 7bb5e76..7ec8303 100644
--- a/docs/api/remctl.3
+++ b/docs/api/remctl.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL 3"
-.TH REMCTL 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -258,13 +258,15 @@ The remctl port number, 4373, was derived by tracing the diagonals of a
Russ Allbery <eagle@eyrie.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
-Copyright 2007, 2008, 2009, 2014 The Board of Trustees of the Leland
-Stanford Junior University
+Copyright 2007\-2009, 2014 The Board of Trustees of the Leland Stanford
+Junior University
.PP
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl_new\fR\|(3), \fIremctl_open\fR\|(3), \fIremctl_command\fR\|(3), \fIremctl_commandv\fR\|(3),
@@ -272,4 +274,4 @@ warranty.
.PP
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl.pod b/docs/api/remctl.pod
index 477cb9e..413784b 100644
--- a/docs/api/remctl.pod
+++ b/docs/api/remctl.pod
@@ -1,7 +1,7 @@
=for stopwords
remctl const API hostname IP NUL-terminated GSS-API DNS KRB5CCNAME NULs
ENOMEM CNAME lookups canonicalization libdefaults canonicalize Allbery
-DNS-based IANA-registered
+DNS-based IANA-registered SPDX-License-Identifier FSFAP
=head1 NAME
@@ -134,13 +134,15 @@ Russ Allbery <eagle@eyrie.org>
=head1 COPYRIGHT AND LICENSE
-Copyright 2007, 2008, 2009, 2014 The Board of Trustees of the Leland
-Stanford Junior University
+Copyright 2007-2009, 2014 The Board of Trustees of the Leland Stanford
+Junior University
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
@@ -149,6 +151,6 @@ remctl_output(3), remctl_close(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/api/remctl_close.3 b/docs/api/remctl_close.3
index 46cf0e0..08a9010 100644
--- a/docs/api/remctl_close.3
+++ b/docs/api/remctl_close.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL_CLOSE 3"
-.TH REMCTL_CLOSE 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL_CLOSE 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -168,10 +168,12 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl_new\fR\|(3), \fIremctl_open\fR\|(3)
.PP
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl_close.pod b/docs/api/remctl_close.pod
index 5d53545..e64c09e 100644
--- a/docs/api/remctl_close.pod
+++ b/docs/api/remctl_close.pod
@@ -1,5 +1,5 @@
=for stopwords
-remctl Allbery
+remctl Allbery SPDX-License-Identifier FSFAP
=head1 NAME
@@ -41,6 +41,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
@@ -48,6 +50,6 @@ remctl_new(3), remctl_open(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/api/remctl_command.3 b/docs/api/remctl_command.3
index ce138d5..cf02360 100644
--- a/docs/api/remctl_command.3
+++ b/docs/api/remctl_command.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL_COMMAND 3"
-.TH REMCTL_COMMAND 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL_COMMAND 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -188,10 +188,12 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl_new\fR\|(3), \fIremctl_open\fR\|(3), \fIremctl_output\fR\|(3), \fIremctl_error\fR\|(3)
.PP
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl_command.pod b/docs/api/remctl_command.pod
index 805084f..3f3a595 100644
--- a/docs/api/remctl_command.pod
+++ b/docs/api/remctl_command.pod
@@ -1,5 +1,6 @@
=for stopwords
-remctl const iovec NUL-terminated argv Allbery
+remctl const iovec NUL-terminated argv Allbery SPDX-License-Identifier
+FSFAP
=head1 NAME
@@ -62,6 +63,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
@@ -69,6 +72,6 @@ remctl_new(3), remctl_open(3), remctl_output(3), remctl_error(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/api/remctl_error.3 b/docs/api/remctl_error.3
index cf7db75..24955ca 100644
--- a/docs/api/remctl_error.3
+++ b/docs/api/remctl_error.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL_ERROR 3"
-.TH REMCTL_ERROR 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL_ERROR 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -173,6 +173,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl_new\fR\|(3), \fIremctl_open\fR\|(3), \fIremctl_command\fR\|(3), \fIremctl_commandv\fR\|(3),
@@ -180,4 +182,4 @@ warranty.
.PP
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl_error.pod b/docs/api/remctl_error.pod
index cc9a554..7425736 100644
--- a/docs/api/remctl_error.pod
+++ b/docs/api/remctl_error.pod
@@ -1,5 +1,5 @@
=for stopwords
-remctl const API Allbery
+remctl const API Allbery SPDX-License-Identifier FSFAP
=head1 NAME
@@ -47,6 +47,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
@@ -55,6 +57,6 @@ remctl_output(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/api/remctl_new.3 b/docs/api/remctl_new.3
index 4f68caf..e0c6833 100644
--- a/docs/api/remctl_new.3
+++ b/docs/api/remctl_new.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL_NEW 3"
-.TH REMCTL_NEW 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL_NEW 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -171,6 +171,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl_open\fR\|(3), \fIremctl_command\fR\|(3), \fIremctl_commandv\fR\|(3), \fIremctl_output\fR\|(3),
@@ -178,4 +180,4 @@ warranty.
.PP
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl_new.pod b/docs/api/remctl_new.pod
index 0616d1e..14e9b6b 100644
--- a/docs/api/remctl_new.pod
+++ b/docs/api/remctl_new.pod
@@ -1,5 +1,5 @@
=for stopwords
-remctl API ENOMEM Allbery
+remctl API ENOMEM Allbery SPDX-License-Identifier FSFAP
=head1 NAME
@@ -45,6 +45,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
@@ -53,6 +55,6 @@ remctl_close(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/api/remctl_noop.3 b/docs/api/remctl_noop.3
index 24184c2..f9c6fe9 100644
--- a/docs/api/remctl_noop.3
+++ b/docs/api/remctl_noop.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL_NOOP 3"
-.TH REMCTL_NOOP 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL_NOOP 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -174,10 +174,12 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl_new\fR\|(3), \fIremctl_open\fR\|(3), \fIremctl_command\fR\|(3), \fIremctl_error\fR\|(3)
.PP
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl_noop.pod b/docs/api/remctl_noop.pod
index 9780ffa..de8210f 100644
--- a/docs/api/remctl_noop.pod
+++ b/docs/api/remctl_noop.pod
@@ -1,5 +1,5 @@
=for stopwords
-remctl const NOOP Allbery
+remctl const NOOP Allbery SPDX-License-Identifier FSFAP
=head1 NAME
@@ -48,6 +48,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
@@ -55,6 +57,6 @@ remctl_new(3), remctl_open(3), remctl_command(3), remctl_error(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/api/remctl_open.3 b/docs/api/remctl_open.3
index 935fd68..12feb8a 100644
--- a/docs/api/remctl_open.3
+++ b/docs/api/remctl_open.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL_OPEN 3"
-.TH REMCTL_OPEN 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL_OPEN 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -254,13 +254,15 @@ The remctl port number, 4373, was derived by tracing the diagonals of a
Russ Allbery <eagle@eyrie.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
-Copyright 2007, 2008, 2009, 2014 The Board of Trustees of the Leland
-Stanford Junior University
+Copyright 2007\-2009, 2014 The Board of Trustees of the Leland Stanford
+Junior University
.PP
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl_new\fR\|(3), \fIremctl_error\fR\|(3), \fIremctl_set_ccache\fR\|(3),
@@ -268,4 +270,4 @@ warranty.
.PP
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl_open.pod b/docs/api/remctl_open.pod
index 6a6caa9..8c11539 100644
--- a/docs/api/remctl_open.pod
+++ b/docs/api/remctl_open.pod
@@ -1,6 +1,7 @@
=for stopwords
remctl const TCP GSS-API DNS DNS-based KRB5CCNAME lookups canonicalization
libdefaults Allbery CNAME ai addr addrinfo addrlen fd IANA-registered
+SPDX-License-Identifier FSFAP
=head1 NAME
@@ -131,13 +132,15 @@ Russ Allbery <eagle@eyrie.org>
=head1 COPYRIGHT AND LICENSE
-Copyright 2007, 2008, 2009, 2014 The Board of Trustees of the Leland
-Stanford Junior University
+Copyright 2007-2009, 2014 The Board of Trustees of the Leland Stanford
+Junior University
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
@@ -146,6 +149,6 @@ remctl_set_source_ip(3), remctl_set_timeout(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/api/remctl_output.3 b/docs/api/remctl_output.3
index 491fa8d..4cc5f97 100644
--- a/docs/api/remctl_output.3
+++ b/docs/api/remctl_output.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL_OUTPUT 3"
-.TH REMCTL_OUTPUT 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL_OUTPUT 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -215,14 +215,6 @@ wishes to preserve before making any subsequent remctl \s-1API\s0 calls.
\&\fIremctl_output()\fR returns a pointer to a remctl_output struct on success and
\&\s-1NULL\s0 on failure. On failure, the caller should call \fIremctl_error()\fR to
retrieve the error message.
-.SH "SEE ALSO"
-.IX Header "SEE ALSO"
-\&\fIremctl_new\fR\|(3), \fIremctl_open\fR\|(3), \fIremctl_command\fR\|(3), \fIremctl_commandv\fR\|(3),
-\&\fIremctl_error\fR\|(3)
-.PP
-The current version of the remctl library and complete details of the
-remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Russ Allbery <eagle@eyrie.org>
@@ -235,3 +227,13 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fIremctl_new\fR\|(3), \fIremctl_open\fR\|(3), \fIremctl_command\fR\|(3), \fIremctl_commandv\fR\|(3),
+\&\fIremctl_error\fR\|(3)
+.PP
+The current version of the remctl library and complete details of the
+remctl protocol are available from its web page at
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl_output.pod b/docs/api/remctl_output.pod
index 98f69ba..ec190ad 100644
--- a/docs/api/remctl_output.pod
+++ b/docs/api/remctl_output.pod
@@ -1,5 +1,5 @@
=for stopwords
-remctl API Allbery
+remctl API Allbery SPDX-License-Identifier FSFAP
=head1 NAME
@@ -83,15 +83,6 @@ remctl_output() returns a pointer to a remctl_output struct on success and
NULL on failure. On failure, the caller should call remctl_error() to
retrieve the error message.
-=head1 SEE ALSO
-
-remctl_new(3), remctl_open(3), remctl_command(3), remctl_commandv(3),
-remctl_error(3)
-
-The current version of the remctl library and complete details of the
-remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
-
=head1 AUTHOR
Russ Allbery <eagle@eyrie.org>
@@ -105,5 +96,16 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
+=head1 SEE ALSO
+
+remctl_new(3), remctl_open(3), remctl_command(3), remctl_commandv(3),
+remctl_error(3)
+
+The current version of the remctl library and complete details of the
+remctl protocol are available from its web page at
+L<https://www.eyrie.org/~eagle/software/remctl/>.
+
=cut
diff --git a/docs/api/remctl_set_ccache.3 b/docs/api/remctl_set_ccache.3
index 1d0ccf8..dc0a2cb 100644
--- a/docs/api/remctl_set_ccache.3
+++ b/docs/api/remctl_set_ccache.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL_SET_CCACHE 3"
-.TH REMCTL_SET_CCACHE 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL_SET_CCACHE 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -206,17 +206,19 @@ elsewhere in the same process.
Russ Allbery <eagle@eyrie.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
-Copyright 2011, 2013, 2014 The Board of Trustees of the Leland Stanford
+Copyright 2011, 2013\-2014 The Board of Trustees of the Leland Stanford
Junior University
.PP
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl_new\fR\|(3), \fIremctl_open\fR\|(3), \fIremctl_error\fR\|(3)
.PP
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl_set_ccache.pod b/docs/api/remctl_set_ccache.pod
index 40a40fa..0268f3c 100644
--- a/docs/api/remctl_set_ccache.pod
+++ b/docs/api/remctl_set_ccache.pod
@@ -1,5 +1,6 @@
=for stopwords
-remctl API Allbery const ccache GSS-API KRB5CCNAME
+remctl API Allbery const ccache GSS-API KRB5CCNAME SPDX-License-Identifier
+FSFAP
=head1 NAME
@@ -80,13 +81,15 @@ Russ Allbery <eagle@eyrie.org>
=head1 COPYRIGHT AND LICENSE
-Copyright 2011, 2013, 2014 The Board of Trustees of the Leland Stanford
+Copyright 2011, 2013-2014 The Board of Trustees of the Leland Stanford
Junior University
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
@@ -94,6 +97,6 @@ remctl_new(3), remctl_open(3), remctl_error(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/api/remctl_set_source_ip.3 b/docs/api/remctl_set_source_ip.3
index cbb8997..3f03551 100644
--- a/docs/api/remctl_set_source_ip.3
+++ b/docs/api/remctl_set_source_ip.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL_SET_SOURCE_IP 3"
-.TH REMCTL_SET_SOURCE_IP 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL_SET_SOURCE_IP 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -175,10 +175,12 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl_new\fR\|(3), \fIremctl_open\fR\|(3), \fIremctl_error\fR\|(3)
.PP
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl_set_source_ip.pod b/docs/api/remctl_set_source_ip.pod
index 65d0116..49e67d6 100644
--- a/docs/api/remctl_set_source_ip.pod
+++ b/docs/api/remctl_set_source_ip.pod
@@ -1,5 +1,6 @@
=for stopwords
remctl API Allbery const IP IPv4 IPv6 IPv4-only IPv6-only
+SPDX-License-Identifier FSFAP
=head1 NAME
@@ -49,6 +50,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
@@ -56,6 +59,6 @@ remctl_new(3), remctl_open(3), remctl_error(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/api/remctl_set_timeout.3 b/docs/api/remctl_set_timeout.3
index 3a54f5b..cb839bf 100644
--- a/docs/api/remctl_set_timeout.3
+++ b/docs/api/remctl_set_timeout.3
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL_SET_TIMEOUT 3"
-.TH REMCTL_SET_TIMEOUT 3 "2018-04-01" "3.14" "remctl Library Reference"
+.TH REMCTL_SET_TIMEOUT 3 "2018-05-05" "3.15" "remctl Library Reference"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -175,6 +175,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl_new\fR\|(3), \fIremctl_command\fR\|(3), \fIremctl_open\fR\|(3), \fIremctl_output\fR\|(3),
@@ -182,4 +184,4 @@ warranty.
.PP
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/api/remctl_set_timeout.pod b/docs/api/remctl_set_timeout.pod
index 870230e..bb12259 100644
--- a/docs/api/remctl_set_timeout.pod
+++ b/docs/api/remctl_set_timeout.pod
@@ -1,5 +1,5 @@
=for stopwords
-remctl API Allbery timeout
+remctl API Allbery timeout SPDX-License-Identifier FSFAP
=head1 NAME
@@ -49,6 +49,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
@@ -57,6 +59,6 @@ remctl_error(3)
The current version of the remctl library and complete details of the
remctl protocol are available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/design.html b/docs/design.html
index 615c5ce..d75e4fc 100644
--- a/docs/design.html
+++ b/docs/design.html
@@ -198,6 +198,8 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
</PRE>
</BODY>
diff --git a/docs/extending b/docs/extending
index 2c2ede0..85830e0 100644
--- a/docs/extending
+++ b/docs/extending
@@ -172,3 +172,5 @@ License
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved. This file is offered as-is,
without any warranty.
+
+ SPDX-License-Identifier: FSFAP
diff --git a/docs/metadata/README b/docs/metadata/README
new file mode 100644
index 0000000..26316da
--- /dev/null
+++ b/docs/metadata/README
@@ -0,0 +1,6 @@
+This directory contains configuration for DocKnot used to generate
+documentation files (like README.md) and web pages. Other documentation
+in this package is generated automatically from these files as part of the
+release process. For more information, see DocKnot's documentation.
+
+DocKnot is available from <https://www.eyrie.org/~eagle/software/docknot/>.
diff --git a/docs/metadata/blurb b/docs/metadata/blurb
new file mode 100644
index 0000000..c062000
--- /dev/null
+++ b/docs/metadata/blurb
@@ -0,0 +1,6 @@
+remctl is a client/server application that supports remote execution of
+specific commands, using Kerberos GSS-API for authentication.
+Authorization is controlled by a configuration file and ACL files and can
+be set separately for each command, unlike with rsh. remctl is like a
+Kerberos-authenticated simple CGI server, or a combination of Kerberos ssh
+and sudo without most of the features and complexity of either.
diff --git a/docs/metadata/bootstrap b/docs/metadata/bootstrap
new file mode 100644
index 0000000..0a018f7
--- /dev/null
+++ b/docs/metadata/bootstrap
@@ -0,0 +1,2 @@
+You will also need pkg-config installed to regenerate configure and
+xml2rfc to build the formatted protocol documentation.
diff --git a/docs/metadata/build/middle b/docs/metadata/build/middle
new file mode 100644
index 0000000..4a2820f
--- /dev/null
+++ b/docs/metadata/build/middle
@@ -0,0 +1,72 @@
+Solaris users should look at `examples/remctld.xml`, an SMF manifest for
+running the `remctld` daemon.
+
+To also build the Perl bindings for the libremctl client library, pass the
+`--enable-perl` option to `configure`. The Perl module build is handled
+by the normal Perl extension build system, and therefore will be built
+with compiler flags defined by your Perl installation and installed into
+your local Perl module directory regardless of the `--prefix` argument to
+`configure`. To change this, you will need to run `perl Makefile.PL` in
+the `perl` subdirectory of the build tree with appropriate options and
+rebuild the module after running `make` and before running `make install`.
+
+To also build the remctl PECL extension for PHP, pass the `--enable-php`
+option to `configure`. The PHP PECL module build is handled by the normal
+PHP extension build system and therefore will be installed into your local
+PHP module directory. The configure script will look for `phpize` on your
+`PATH` by default; if it's in some other directory, set the `PHPIZE`
+environment variable to the full path or set it on the configure command
+line. The configure script for the PECL extension will be run during the
+build instead of during configure. This is unfortunately apparently
+unavoidable given how the PECL build system works.
+
+To also build the Python bindings for the libremctl client library, pass
+the `--enable-python` option to configure. The Python module build is
+handled by the normal Python extension build system, and therefore will be
+installed into your local Python module directory regardless of the
+`--prefix` argument to `configure`. To change this, you will need to run
+`python setup.py install` by hand in the `python` directory with whatever
+options you want to use.
+
+To also build the Ruby bindings for the libremctl client library, pass
+the `--enable-ruby` option to configure. The Ruby module build is handled
+by the normal Ruby module build system, and therefore will be installed
+into your local Ruby module directory regardless of the `--prefix`
+argument to `configure`. To change this, override the `sitedir` variable on
+the `make install` command line, as in:
+
+```
+ make install sitedir=/opt/ruby
+```
+
+The remctl build system also supports a few other environment variables
+that can be set to control aspects of the Perl, Python, and Ruby binding
+build systems. These are primarily only of use when packaging the
+software. For more information, a list of the variables, and their
+effects, see the comment at the start of `Makefile.am`.
+
+The Java client and server aren't integrated with the regular build
+system. For information on building and installing them, see
+`java/README`.
+
+remctl will use pkg-config if it's available to find the build flags for
+libevent. You can control which pkg-config binary and paths are used with
+the normal pkg-config environment variables of `PKG_CONFIG`,
+`PKG_CONFIG_PATH`, and `PKG_CONFIG_LIBDIR`, and you can override the
+pkg-config results with `LIBEVENT_CFLAGS` and `LIBEVENT_LIBS`.
+Alternately, you can bypass pkg-config by passing one or more of
+`--with-libevent`, `--with-libevent-include`, and `--with-libevent-lib` to
+indicate the install prefix, include directory, or library directory.
+
+remctl will automatically build with PCRE support if pcre-config or the
+PCRE library are found. You can pass `--with-pcre` to configure to
+specify the root directory where PCRE is installed, or set the include and
+library directories separately with `--with-pcre-include` and
+`--with-pcre-lib`. You can also set `PCRE_CONFIG` to point to a different
+pcre-config script, or do similar things as with `PATH_KRB5_CONFIG`
+described below.
+
+remctl will automatically build with GPUT support if the GPUT header and
+library are found. You can pass `--with-gput` to configure to specify the
+root directory where GPUT is installed, or set the include and library
+directories separately with `--with-gput-include` and `--with-gput-lib`.
diff --git a/docs/metadata/description b/docs/metadata/description
new file mode 100644
index 0000000..09aff27
--- /dev/null
+++ b/docs/metadata/description
@@ -0,0 +1,49 @@
+remctl is a client/server application that supports remote execution of
+specific commands, using Kerberos GSS-API for authentication and
+confidentiality. The commands a given user can execute are controlled by
+a configuration file and ACL files and can easily be tightly limited,
+unlike with rsh. The mapping of command to backend program is done by the
+configuration file, which allows some additional flexibility compared to
+ssh command restrictions and works with Kerberos authentications rather
+than being limited to public key authentications.
+
+remctld is very similar to a CGI server that uses a different network
+protocol than HTTP, always does strong authentication before executing the
+desired command, and guarantees the data is encrypted on the network.
+Alternately, you can think of it as a very simple combination of Kerberos
+ssh and sudo, without most of the features of both but with simpler
+authorization.
+
+There are a lot of different client/server systems that do something
+similar, including regular rsh, CGI, IBM's sysctl (not to be confused with
+the Linux kernel call and configuration file of the same name), CERN's
+arc, and more elaborate systems like MIT's Moira. remctl has the
+advantage over many of these schemes of using GSS-API and being about as
+simple as it possibly can be while still being useful. It doesn't require
+any particular programming language, builds self-contained binaries, and
+uses as minimal of a protocol as possible.
+
+Both C and Java clients and servers are provided, as well as Perl, PHP,
+and Python bindings for the C client library. For more information about
+the Java client, see `java/README`. For more information about the PHP
+bindings, see `php/README`. For more information about the Python
+bindings, see `python/README`.
+
+Also included in the remctl package is an alternate way of running the
+remctl server: remctl-shell. This program is designed to be run as either
+a shell or a forced command under ssh, using ssh for authentication and
+communicating the authentication information to remctl-shell via either
+environment variables or command-line arguments via the forced command
+configuration. This version of the server uses simple ssh clients, rather
+than using the remctl client program or libraries.
+
+remctl was originally written by Anton Ushakov as a replacement for IBM's
+sysctl, a client/server application with Kerberos v4 authentication that
+allowed the client to run Tcl code on the server, protected by ACLs. At
+Stanford, we used sysctl extensively, but mostly only to run external
+programs, so remctl was developed as a Kerberos v5 equivalent that did
+only the portions we needed.
+
+Complete protocol documentation is available in `docs/protocol.html`.
+Also present, as `docs/design.html`, is the original design document (now
+somewhat out of date).
diff --git a/docs/metadata/metadata.json b/docs/metadata/metadata.json
new file mode 100644
index 0000000..03c3ea0
--- /dev/null
+++ b/docs/metadata/metadata.json
@@ -0,0 +1,169 @@
+{
+ "name": "remctl",
+ "version": "3.15",
+ "synopsis": "remote authenticated command execution with ACLs",
+ "maintainer": "Russ Allbery <eagle@eyrie.org>",
+ "copyrights": [
+ {
+ "holder": "Russ Allbery <eagle@eyrie.org>",
+ "years": "2015-2016, 2018",
+ },
+ {
+ "holder": "The Board of Trustees of the Leland Stanford Junior University",
+ "years": "2002-2014",
+ },
+ ],
+ "license": "Expat",
+ "build": {
+ "autotools": true,
+ "automake": "1.11",
+ "autoconf": "2.64",
+ "gssapi": true,
+ "install": true,
+ "kerberos": true,
+ "lancaster": true,
+ "manpages": true,
+ "reduced_depends": true,
+ "type": "Autoconf",
+ },
+ "support": {
+ "email": "eagle@eyrie.org",
+ "github": "rra/remctl",
+ "web": "https://www.eyrie.org/~eagle/software/remctl/",
+ },
+ "vcs": {
+ "type": "Git",
+ "url": "https://git.eyrie.org/git/kerberos/remctl.git",
+ "browse": "https://git.eyrie.org/?p=kerberos/remctl.git",
+ "github": "rra/remctl",
+ "openhub": "https://www.openhub.net/p/remctl",
+ "travis": "rra/remctl",
+ },
+ "readme": {
+ "sections": [
+ { "title": "Building on Windows" },
+ ],
+ },
+ "quote": {
+ "author": "Peter Marshall",
+ },
+ "distribution": {
+ "section": "kerberos",
+ "tarname": "remctl",
+ "version": "remctl",
+ },
+ "packaging": {
+ "debian": "remctl",
+ },
+ "advisories": [
+ {
+ "date": "2018-04-01",
+ "versions": "3.12 and 3.13",
+ "threshold": "3.14",
+ },
+ ],
+ "docs": {
+ "user": [
+ {
+ "name": "java-readme",
+ "title": "Java client and server README",
+ },
+ {
+ "name": "php-readme",
+ "title": "PHP bindings README",
+ },
+ {
+ "name": "python-readme",
+ "title": "Python bindings README",
+ },
+ {
+ "name": "ruby-readme",
+ "title": "Ruby bindings README",
+ },
+ {
+ "name": "remctl",
+ "title": "remctl manual page",
+ },
+ {
+ "name": "remctl-shell",
+ "title": "remctl-shell manual page",
+ },
+ {
+ "name": "remctld",
+ "title": "remctld manual page",
+ },
+ {
+ "name": "thanks",
+ "title": "Thanks and credits",
+ },
+ ],
+ "developer": [
+ {
+ "name": "extending",
+ "title": "Extending remctl",
+ },
+ {
+ "name": "protocol",
+ "title": "Protocol specification",
+ },
+ {
+ "name": "protocol-v4",
+ "title": "Protocol v4 draft",
+ },
+ ],
+ "api": [
+ {
+ "name": "remctl-api",
+ "title": "remctl and remctl_free_result",
+ },
+ {
+ "name": "remctl_new",
+ "title": "remctl_new",
+ },
+ {
+ "name": "remctl_open",
+ "title": "remctl_open",
+ },
+ {
+ "name": "remctl_command",
+ "title": "remctl_command and remctl_commandv",
+ },
+ {
+ "name": "remctl_output",
+ "title": "remctl_output",
+ },
+ {
+ "name": "remctl_noop",
+ "title": "remctl_noop",
+ },
+ {
+ "name": "remctl_close",
+ "title": "remctl_close",
+ },
+ {
+ "name": "remctl_error",
+ "title": "remctl_error",
+ },
+ {
+ "name": "remctl_set_ccache",
+ "title": "remctl_set_ccache",
+ },
+ {
+ "name": "remctl_set_source_ip",
+ "title": "remctl_set_source_ip",
+ },
+ {
+ "name": "remctl_set_timeout",
+ "title": "remctl_set_timeout",
+ },
+ {
+ "name": "net-remctl",
+ "title": "Net::Remctl Perl module",
+ },
+ {
+ "name": "net-remctl-backend",
+ "title": "Net::Remctl::Backend Perl module",
+ },
+ ],
+ },
+}
diff --git a/docs/metadata/quote b/docs/metadata/quote
new file mode 100644
index 0000000..f832afb
--- /dev/null
+++ b/docs/metadata/quote
@@ -0,0 +1 @@
+Small deeds done are better than great deeds planned.
diff --git a/docs/metadata/requirements b/docs/metadata/requirements
new file mode 100644
index 0000000..83bc59e
--- /dev/null
+++ b/docs/metadata/requirements
@@ -0,0 +1,52 @@
+The remctld server and the standard client are written in C and require a
+C compiler and GSS-API libraries to build. Both will build against either
+MIT Kerberos or Heimdal of any reasonable vintage. remctl will also build
+against the Kerberos GSS-API implementation shipped with AIX 5.2 (and
+possibly later versions) and the Solaris 10 generic GSS-API library (and
+possibly later versions). The `remctl_set_ccache` implementation is
+improved by building with Kerberos libraries and a GSS-API library that
+supports `gss_krb5_import_cred`.
+
+The remctld server requires libevent 1.4.x or later. It's only been
+tested with libevent 1.4.13-stable and later, but should work with 1.4.4
+or later. It is now only tested with libevent 2.x, so moving to a later
+version of libevent if possible is recommended.
+
+The remctl server will support regex ACLs if the system supports the POSIX
+regex API. The remctl server also optionally supports PCRE regular
+expressions in ACLs. To include that support, the PCRE library is
+required.
+
+To build the remctl client for Windows, the Microsoft Windows SDK for
+Windows Vista and the MIT Kerberos for Windows SDK are required, along
+with a Microsoft Windows build environment (probably Visual Studio).
+remctl has only been tested with the 3.2.1 MIT Kerberos for Windows SDK.
+To run the resulting binary, MIT Kerberos for Windows must be installed
+and configured. The client was tested on Windows XP and Vista and should
+work on Windows 2000 and up; however, the primary maintainer does not use
+or test Windows, so it's always possible Windows support has broken. The
+server is not supported on Windows.
+
+To build the Perl bindings for the C client library, you will need Perl
+5.8 or later.
+
+To build the PHP bindings for the C client library, you will need PHP 5.x
+or later and phpize, plus any other programs that phpize requires. PHP
+5.x support has only been tested on 5.2 and 5.3, and PHP support is now
+only tested on PHP 7.x and later.
+
+To build the Python bindings for the C client library, you will need
+Python 2.3 or later (primarily tested with Python 2.7). Python 3 is not
+(yet) supported.
+
+To build the Ruby bindings for the C client library, you will need Ruby
+1.8 or later (primarily tested with 2.5 and later).
+
+None of the language bindings have been tested on Windows.
+
+A Java client and Java server are available in the java subdirectory, but
+they are not integrated into the normal build or built by default. There
+is a basic Makefile in that directory that may require some tweaking. It
+currently requires the Sun Java JDK (1.4.2, 5, or 6) or OpenJDK 6 or
+later. A considerably better Java client implementation is available on
+the `java` branch in the Git repository but has not yet been merged.
diff --git a/docs/metadata/sections/building-on-windows b/docs/metadata/sections/building-on-windows
new file mode 100644
index 0000000..3a08d3d
--- /dev/null
+++ b/docs/metadata/sections/building-on-windows
@@ -0,0 +1,31 @@
+(These instructions are not tested by the author and are now dated.
+Updated instructions via a pull request, issue, or email are very
+welcome.)
+
+First, install the Microsoft Windows SDK for Windows Vista if you have not
+already. This is a free download from Microsoft for users of "Genuine
+Microsoft Windows." The `vcvars32.bat` environment provided by Visual
+Studio may work as an alternative, but has not been tested.
+
+Next, install the [MIT Kerberos for Windows
+SDK](https://web.mit.edu/kerberos/www/dist/index.html). remctl has been
+tested with version 3.2.1 but should hopefully work with later versions.
+
+Then, follow these steps:
+
+1. Run the `InitEnv.cmd` script included with the Windows SDK with
+ parameters `"/xp /release"`.
+
+2. Run the `configure.bat` script, giving it as an argument the location
+ of the Kerberos for Windows SDK. For example, if you installed the KfW
+ SDK in `"c:\KfW SDK"`, you should run:
+
+ ```
+ configure "c:\KfW SDK"
+ ```
+
+3. Run `nmake` to start compiling. You can ignore the warnings.
+
+If all goes well, you will have `remctl.exe` and `remctl.dll`. The latter
+is a shared library used by the client program. It exports the same
+interface as the UNIX libremctl library.
diff --git a/docs/metadata/test/prefix b/docs/metadata/test/prefix
new file mode 100644
index 0000000..1afd097
--- /dev/null
+++ b/docs/metadata/test/prefix
@@ -0,0 +1,10 @@
+remctl comes with a comprehensive test suite, but it requires some
+configuration in order to test anything other than low-level utility
+functions. For the full test suite, you will need to have a keytab that
+can authenticate to a running KDC. Using a test KDC environment, if you
+have one, is recommended.
+
+Follow the instructions in `tests/config/README` to configure the test
+suite.
+
+Now, you can run the test suite with:
diff --git a/docs/metadata/test/suffix b/docs/metadata/test/suffix
new file mode 100644
index 0000000..a0cf1e3
--- /dev/null
+++ b/docs/metadata/test/suffix
@@ -0,0 +1,27 @@
+On particularly slow or loaded systems, you may see intermittant failures
+from the `server/streaming` test because it's timing-sensitive.
+
+The test suite will also need to be able to bind to 127.0.0.1 on port
+11119 and 14373 to run test network server programs.
+
+To test anonymous authentication, the KDC configured in the test suite
+needs to support service tickets for the anonymous identity (not a
+standard configuration). This test will be skipped if the KDC does not
+support this.
+
+To test user handling in remctld, you will need the `fakeroot` command
+(available in the `fakeroot` package in Debian and Ubuntu). This test
+will be skipped if `fakeroot` isn't available.
+
+The following additional Perl modules will be used by the test suite for
+the main package and the Perl bindings if installed:
+
+* Test::MinimumVersion
+* Test::Perl::Critic
+* Test::Pod
+* Test::Spelling
+* Test::Strict
+* Test::Synopsis
+
+All are available on CPAN. Those tests will be skipped if the modules are
+not available.
diff --git a/docs/protocol-v4 b/docs/protocol-v4
index 963d987..f38b67a 100644
--- a/docs/protocol-v4
+++ b/docs/protocol-v4
@@ -141,3 +141,5 @@ License
are permitted in any medium without royalty provided the copyright
notice and this notice are preserved. This file is offered as-is,
without any warranty.
+
+ SPDX-License-Identifier: FSFAP
diff --git a/docs/protocol.html b/docs/protocol.html
index 8ba60f3..823cd4b 100644
--- a/docs/protocol.html
+++ b/docs/protocol.html
@@ -413,7 +413,7 @@
</tr>
<tr>
<td class="left"></td>
-<td class="right">Stanford University</td>
+<td class="right">Dropbox</td>
</tr>
<tr>
<td class="left"></td>
@@ -605,7 +605,7 @@
<a href="#rfc.appendix.B">Appendix B.</a> <a href="#license" id="license">Additional License</a>
</h1>
<p id="rfc.section.B.p.1">This section supplements the Copyright Notice section at the start of this document. It states an additional copyright notice and grants a much less restrictive license than the default IETF Trust license. You may copy and distribute this document, with or without modification, under your choice of the license specified in the Copyright Notice section or the license below.</p>
-<p id="rfc.section.B.p.2">Copyright 2006, 2007, 2008, 2009, 2011, 2013, 2014 The Board of Trustees of the Leland Stanford Junior University</p>
+<p id="rfc.section.B.p.2">Copyright 2006-2009, 2011, 2013-2014 The Board of Trustees of the Leland Stanford Junior University</p>
<p id="rfc.section.B.p.3">Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved. This file is offered as-is, without any warranty.</p>
<h1 id="rfc.authors"><a href="#rfc.authors">Author's Address</a></h1>
<div class="avoidbreak">
@@ -616,20 +616,19 @@
<span class="family-name">Allbery</span>
</span>
</span>
- <span class="org vcardline">Stanford University</span>
+ <span class="org vcardline">Dropbox</span>
<span class="adr">
- <span class="vcardline">255 Panama Street, MC 4136</span>
-
+
<span class="vcardline">
- <span class="locality">Stanford</span>,
- <span class="region">CA</span>
- <span class="code">94305-4136</span>
+ <span class="locality"></span>
+ <span class="region"></span>
+ <span class="code"></span>
</span>
- <span class="country-name vcardline">US</span>
+ <span class="country-name vcardline"></span>
</span>
<span class="vcardline">EMail: <a href="mailto:eagle@eyrie.org">eagle@eyrie.org</a></span>
-<span class="vcardline">URI: <a href="http://www.eyrie.org/~eagle/">http://www.eyrie.org/~eagle/</a></span>
+<span class="vcardline">URI: <a href="https://www.eyrie.org/~eagle/">https://www.eyrie.org/~eagle/</a></span>
</address>
</div>
diff --git a/docs/protocol.txt b/docs/protocol.txt
index 034b9e6..5b647de 100644
--- a/docs/protocol.txt
+++ b/docs/protocol.txt
@@ -3,7 +3,7 @@
R. Allbery
- Stanford University
+ Dropbox
January 1, 2014
@@ -515,8 +515,8 @@ Appendix B. Additional License
modification, under your choice of the license specified in the
Copyright Notice section or the license below.
- Copyright 2006, 2007, 2008, 2009, 2011, 2013, 2014 The Board of
- Trustees of the Leland Stanford Junior University
+ Copyright 2006-2009, 2011, 2013-2014 The Board of Trustees of the
+ Leland Stanford Junior University
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
@@ -526,13 +526,13 @@ Appendix B. Additional License
Author's Address
Russ Allbery
- Stanford University
- 255 Panama Street, MC 4136
- Stanford, CA 94305-4136
- US
+ Dropbox
Email: eagle@eyrie.org
- URI: http://www.eyrie.org/~eagle/
+ URI: https://www.eyrie.org/~eagle/
+
+
+
diff --git a/docs/protocol.xml b/docs/protocol.xml
index 896071d..ba21744 100644
--- a/docs/protocol.xml
+++ b/docs/protocol.xml
@@ -5,15 +5,10 @@
<front>
<title abbrev="remctl">remctl: Remote Authenticated Command Service</title>
<author initials='R.' surname='Allbery' fullname='Russ Allbery'>
- <organization>Stanford University</organization>
+ <organization>Dropbox</organization>
<address>
- <postal>
- <street>255 Panama Street, MC 4136</street>
- <city>Stanford</city> <region>CA</region>
- <code>94305-4136</code> <country>US</country>
- </postal>
<email>eagle@eyrie.org</email>
- <uri>http://www.eyrie.org/~eagle/</uri>
+ <uri>https://www.eyrie.org/~eagle/</uri>
</address>
</author>
<date month='January' year='2014' />
@@ -507,13 +502,15 @@
without modification, under your choice of the license specified in
the Copyright Notice section or the license below.</t>
- <t>Copyright 2006, 2007, 2008, 2009, 2011, 2013, 2014 The Board of
- Trustees of the Leland Stanford Junior University</t>
+ <t>Copyright 2006-2009, 2011, 2013-2014 The Board of Trustees of the
+ Leland Stanford Junior University</t>
<t>Copying and distribution of this file, with or without
modification, are permitted in any medium without royalty provided
the copyright notice and this notice are preserved. This file is
offered as-is, without any warranty.</t>
+
+ <!-- SPDX-License-Identifier: FSFAP -->
</section>
</back>
</rfc>
diff --git a/docs/remctl-shell.8.in b/docs/remctl-shell.8.in
index 9bb1f73..136679c 100644
--- a/docs/remctl-shell.8.in
+++ b/docs/remctl-shell.8.in
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL-SHELL 8"
-.TH REMCTL-SHELL 8 "2018-04-01" "3.14" "remctl"
+.TH REMCTL-SHELL 8 "2018-05-05" "3.15" "remctl"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -490,9 +490,11 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctld\fR\|(8), \fIsshd\fR\|(8)
.PP
The current version of this program is available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/remctl-shell.pod b/docs/remctl-shell.pod
index 608a6fb..895cea0 100644
--- a/docs/remctl-shell.pod
+++ b/docs/remctl-shell.pod
@@ -1,5 +1,6 @@
=for stopwords
remctl -dqS -dhqSv ACL Allbery GSS-API REMUSER nul remctld sshd subcommand
+SPDX-License-Identifier FSFAP
=head1 NAME
@@ -369,12 +370,14 @@ Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
remctld(8), sshd(8)
The current version of this program is available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/remctl.1 b/docs/remctl.1
index 29a82fc..2902370 100644
--- a/docs/remctl.1
+++ b/docs/remctl.1
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTL 1"
-.TH REMCTL 1 "2018-04-01" "3.14" "remctl"
+.TH REMCTL 1 "2018-05-05" "3.15" "remctl"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -237,16 +237,18 @@ The remctl port number, 4373, was derived by tracing the diagonals of a
maintenance are done by Russ Allbery <eagle@eyrie.org>.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
-Copyright 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2014
-The Board of Trustees of the Leland Stanford Junior University
+Copyright 2002\-2011, 2014 The Board of Trustees of the Leland Stanford
+Junior University
.PP
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIkinit\fR\|(1), \fIremctld\fR\|(8)
.PP
The current version of this program is available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/remctl.pod b/docs/remctl.pod
index 008c8de..668a416 100644
--- a/docs/remctl.pod
+++ b/docs/remctl.pod
@@ -2,6 +2,7 @@
remctl -dhv subcommand remctld GSS-API GSS-API's hostname AFS
canonicalizes DNS DNS-based canonicalization Heimdal MICs Ushakov Allbery
triple-DES MERCHANTABILITY IP IPv4 IPv6 source-ip IANA-registered
+SPDX-License-Identifier FSFAP
=head1 NAME
@@ -125,19 +126,21 @@ maintenance are done by Russ Allbery <eagle@eyrie.org>.
=head1 COPYRIGHT AND LICENSE
-Copyright 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2014
-The Board of Trustees of the Leland Stanford Junior University
+Copyright 2002-2011, 2014 The Board of Trustees of the Leland Stanford
+Junior University
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
kinit(1), remctld(8)
The current version of this program is available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut
diff --git a/docs/remctld.8.in b/docs/remctld.8.in
index c8d27ef..70f9955 100644
--- a/docs/remctld.8.in
+++ b/docs/remctld.8.in
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "REMCTLD 8"
-.TH REMCTLD 8 "2018-04-01" "3.14" "remctl"
+.TH REMCTLD 8 "2018-05-05" "3.15" "remctl"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -802,16 +802,18 @@ The remctl port number, 4373, was derived by tracing the diagonals of a
maintenance are done by Russ Allbery <eagle@eyrie.org>.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
-Copyright 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011,
-2012, 2014 The Board of Trustees of the Leland Stanford Junior University
+Copyright 2002\-2012, 2014 The Board of Trustees of the Leland Stanford
+Junior University
.PP
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+.PP
+SPDX-License-Identifier: \s-1FSFAP\s0
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIremctl\fR\|(1), \fIsyslog\fR\|(3), \fItcpserver\fR\|(1)
.PP
The current version of this program is available from its web page at
-<http://www.eyrie.org/~eagle/software/remctl/>.
+<https://www.eyrie.org/~eagle/software/remctl/>.
diff --git a/docs/remctld.pod b/docs/remctld.pod
index b58e269..aa2c299 100644
--- a/docs/remctld.pod
+++ b/docs/remctld.pod
@@ -4,6 +4,7 @@ backend logmask NUL acl ACL princ filename gput CMU GPUT xform ANYUSER IP
IPv4 IPv6 hostname SCPRINCIPAL sysctld Heimdal MICs Ushakov Allbery
subcommands REMUSER pcre PCRE triple-DES MERCHANTABILITY username arg
SIGCONT SIGSTOP systemd IANA-registered localgroup PKINIT anyuser
+SPDX-License-Identifier FSFAP
=head1 NAME
@@ -711,19 +712,21 @@ maintenance are done by Russ Allbery <eagle@eyrie.org>.
=head1 COPYRIGHT AND LICENSE
-Copyright 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011,
-2012, 2014 The Board of Trustees of the Leland Stanford Junior University
+Copyright 2002-2012, 2014 The Board of Trustees of the Leland Stanford
+Junior University
Copying and distribution of this file, with or without modification, are
permitted in any medium without royalty provided the copyright notice and
this notice are preserved. This file is offered as-is, without any
warranty.
+
+SPDX-License-Identifier: FSFAP
=head1 SEE ALSO
remctl(1), syslog(3), tcpserver(1)
The current version of this program is available from its web page at
-L<http://www.eyrie.org/~eagle/software/remctl/>.
+L<https://www.eyrie.org/~eagle/software/remctl/>.
=cut