Add manpages for NSS modules (#786)

5 files changed, 94 insertions, 1 deletions

diff --git a/packages/google-compute-engine-oslogin/nss_module/nss-cache-oslogin.8 b/packages/google-compute-engine-oslogin/nss_module/nss-cache-oslogin.8
new file mode 100644
index 0000000..aaf4f8e
--- /dev/null
+++ b/packages/google-compute-engine-oslogin/nss_module/nss-cache-oslogin.8
@@ -0,0 +1,48 @@
+'\" t
+.TH "NSS\-CACHE\-OSLOGIN" "8" "2019-06-06" "Google Cloud"
+
+.\" IF GNU troff set Aq to sequence aq (Apostrophe quote)
+.ie \n(.g .ds Aq \(aq
+.\" ELSE set Aq to '
+.el       .ds Aq '
+
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+
+.SH "NAME"
+nss-cache-oslogin, libnss_cache_oslogin.so.2 \- UNIX implementation for OS Login Users and Groups with local caching\&.
+
+.SH "SYNOPSIS"
+libnss_cache_oslogin\&.so\&.2
+
+.SH "DESCRIPTION"
+\fBnss\-cache\-oslogin\fR is a plug\-in module for the GNU Name Service Switch
+(NSS) functionality of the GNU C Library (\fBglibc\fR)\&.
+This module provides UNIX name resolution from a local cache of users and groups
+configured in the \fIGoogle Cloud OS Login\fR system\&.
+The "passwd" and "group" services are supported by this module\&.
+.PP
+To use the NSS module, add "cache_oslogin" to the appropriate service lines
+in nsswitch\&.conf\&.
+It is recommended to place "cache_oslogin" after any system provided modules
+and before the "oslogin" module, as it is a pass-through cache.
+
+.SH "FILES"
+.IP /etc/oslogin_passwd.cache
+user cache file
+.IP /etc/oslogin_group.cache
+group cache file
+
+.SH "NOTES"
+Documentation for the Google Cloud OS Login service is available online at
+.UR "https://cloud.google.com/compute/docs/oslogin"
+.UE
+
+.SH "SEE ALSO"
+.BR nss-oslogin (5),
+.BR nsswitch.conf (5),
+.BR nss (5),
+.BR getent (1),
+.BR initgroups (3)
diff --git a/packages/google-compute-engine-oslogin/nss_module/nss-oslogin.8 b/packages/google-compute-engine-oslogin/nss_module/nss-oslogin.8
new file mode 100644
index 0000000..3f4c763
--- /dev/null
+++ b/packages/google-compute-engine-oslogin/nss_module/nss-oslogin.8
@@ -0,0 +1,41 @@
+'\" t
+.TH "NSS\-OSLOGIN" "8" "2019-06-06" "Google Cloud"
+
+.\" IF GNU troff set Aq to sequence aq (Apostrophe quote)
+.ie \n(.g .ds Aq \(aq
+.\" ELSE set Aq to '
+.el       .ds Aq '
+
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+
+.SH "NAME"
+nss-oslogin, libnss_oslogin.so.2 \- UNIX implementation for OS Login Users and Groups\&.
+
+.SH "SYNOPSIS"
+libnss_oslogin\&.so\&.2
+
+.SH "DESCRIPTION"
+\fBnss\-oslogin\fR is a plug\-in module for the GNU Name Service Switch (NSS)
+functionality of the GNU C Library (\fBglibc\fR).
+This module provides UNIX name resolution for users and groups configured
+through the \fIGoogle Cloud OS Login\fR system\&.
+The "passwd", "group", and "initgroups" services are supported by this module.
+.PP
+To use the NSS module, add "oslogin" to the appropriate service lines
+in nsswitch\&.conf\&.
+It is recommended to place "oslogin" as the last entry for each service.
+
+.SH "NOTES"
+Documentation for the Google Cloud OS Login service is available online at
+.UR "https://cloud.google.com/compute/docs/oslogin"
+.UE
+
+.SH "SEE ALSO"
+.BR nss-cache-oslogin (8),
+.BR nsswitch.conf (5),
+.BR nss (5),
+.BR getent (1),
+.BR initgroups (3)
diff --git a/packages/google-compute-engine-oslogin/packaging/debian/changelog b/packages/google-compute-engine-oslogin/packaging/debian/changelog
index edb4f8e..a09513c 100644
--- a/packages/google-compute-engine-oslogin/packaging/debian/changelog
+++ b/packages/google-compute-engine-oslogin/packaging/debian/changelog
@@ -2,7 +2,7 @@ google-compute-engine-oslogin (1.5.3-1) unstable; urgency=low
 
   * Update OS Login control file for FreeBSD support.
 
- -- Google Cloud Team <gc-team@google.com>  Tue, 22 Nay 2019 12:00:00 -0700
+ -- Google Cloud Team <gc-team@google.com>  Wed, 22 May 2019 12:00:00 -0700
 
 google-compute-engine-oslogin (1.5.2-1) unstable; urgency=low
 
diff --git a/packages/google-compute-engine-oslogin/packaging/debian/links b/packages/google-compute-engine-oslogin/packaging/debian/links
new file mode 100644
index 0000000..7d96d15
--- /dev/null
+++ b/packages/google-compute-engine-oslogin/packaging/debian/links
@@ -0,0 +1,2 @@
+usr/share/man/man8/nss-oslogin.8.gz usr/share/man/man8/libnss_oslogin.so.2.8.gz
+usr/share/man/man8/nss-cache-oslogin.8.gz usr/share/man/man8/libnss_cache_oslogin.so.2.8.gz
diff --git a/packages/google-compute-engine-oslogin/packaging/debian/manpages b/packages/google-compute-engine-oslogin/packaging/debian/manpages
new file mode 100644
index 0000000..2156c20
--- /dev/null
+++ b/packages/google-compute-engine-oslogin/packaging/debian/manpages
@@ -0,0 +1,2 @@
+nss_module/nss-oslogin.8
+nss_module/nss-cache-oslogin.8