From 1654f42194ba7804c99d5ac96346a1a19fb793d7 Mon Sep 17 00:00:00 2001 From: Iker Pedrosa Date: Fri, 19 Nov 2021 12:22:05 +0100 Subject: [PATCH] README: update content and format * Change to markdown format * Include an introduction * Remove the commit mailing list from the contacts * Add the IRC channel to the contacts * Move 'S/Key' section to doc/README.skey * Move authors and maintainers to AUTHORS.md Signed-off-by: Iker Pedrosa --- README => AUTHORS.md | 51 ++++++-------------------------------------- README.md | 36 +++++++++++++++++++++++++++++++ doc/README.skey | 4 ++++ 3 files changed, 47 insertions(+), 44 deletions(-) rename README => AUTHORS.md (75%) create mode 100644 README.md create mode 100644 doc/README.skey diff --git a/README b/AUTHORS.md similarity index 75% rename from README rename to AUTHORS.md index 6c17b6a7..29fd1ddf 100644 --- a/README +++ b/AUTHORS.md @@ -1,42 +1,14 @@ -Shadow SITES -============ - -Homepage - https://github.com/shadow-maint/shadow - -Issue tracker - https://github.com/shadow-maint/shadow/issues - -Releases - https://github.com/shadow-maint/shadow/releases - -Mailing lists - for general discuss: pkg-shadow-devel@alioth-lists.debian.net - commit list: pkg-shadow-commits@alioth-lists.debian.net - -Mailing lists subscription - https://alioth-lists.debian.net/mailman/listinfo/pkg-shadow-devel - https://alioth-lists.debian.net/mailman/listinfo/pkg-shadow-commits - -Mailing lists archives: - https://alioth-lists.debian.net/pipermail/pkg-shadow-devel/ - https://alioth-lists.debian.net/pipermail/pkg-shadow-commits/ - -S/Key support: - Shadow can be built with S/Key support using the S/Key package from: - - http://cvsweb.netbsd.org/bsdweb.cgi/src/lib/libskey/ - or - https://gentoo.osuosl.org/distfiles/skey-1.1.5.tar.bz2 - -Authors and contributors -======================== - Thanks to at least the following people for sending patches, bug -reports and various comments. This list may be incomplete, I received +reports and various comments. This list may be incomplete, I received a lot of mail... +# Maintainers +Tomasz Kłoczko (2000-2007) +Nicolas François (2007-2014) +Serge E. Hallyn (2014-now) +Christian Brauner (2019-now) +# Authors and contributors Adam Rudnicki Alan Curry Aleksa Sarai @@ -114,12 +86,3 @@ Tim Hockin Timo Karjalainen Ulisses Alonso Camaro Werner Fink - -Maintainers -=========== - -Tomasz Kłoczko (2000-2007) -Nicolas François (2007-2014) -Serge E. Hallyn (2014-now) -Christian Brauner (2019-now) - diff --git a/README.md b/README.md new file mode 100644 index 00000000..3c035ef6 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# shadow-utils + +## Introduction +The shadow-utils package includes the necessary programs for +converting UNIX password files to the shadow password format, plus +programs for managing user and group accounts. The pwconv command +converts passwords to the shadow password format. The pwunconv command +unconverts shadow passwords and generates a passwd file (a standard +UNIX password file). The pwck command checks the integrity of password +and shadow files. The lastlog command prints out the last login times +for all users. The useradd, userdel, and usermod commands are used for +managing user accounts. The groupadd, groupdel, and groupmod commands +are used for managing group accounts. + +## Sites +* [Homepage](https://github.com/shadow-maint/shadow) +* [Issue tracker](https://github.com/shadow-maint/shadow/issues) +* [Releases](https://github.com/shadow-maint/shadow/releases) + +## Contacts +There are several ways to contact us: +* [the general discussion mailing list]( + https://alioth-lists.debian.net/mailman/listinfo/pkg-shadow-devel) +* the #shadow IRC channel on libera.chat: + * irc://irc.libera.chat/shadow + +### Mailing archives +* [the general discussion mailing list archive]( + https://alioth-lists.debian.net/pipermail/pkg-shadow-devel/) +* [the commit mailing list archive]( + https://alioth-lists-archive.debian.net/pipermail/pkg-shadow-commits/), + only used for historical purposes + +## Authors and maintainers +Authors and maintainers are listed in [AUTHORS.md]( +https://github.com/shadow-maint/shadow/blob/master/AUTHORS.md). diff --git a/doc/README.skey b/doc/README.skey new file mode 100644 index 00000000..5829c174 --- /dev/null +++ b/doc/README.skey @@ -0,0 +1,4 @@ +# S/Key support +shadow-utils can be built with S/Key support using the S/Key package from: +* http://cvsweb.netbsd.org/bsdweb.cgi/src/lib/libskey/ or +* https://gentoo.osuosl.org/distfiles/skey-1.1.5.tar.bz2