Merge pull request #15 from goyox86/goyox86-readme

README and docs tweaks.
This commit is contained in:
Jeremy Soller
2017-11-08 16:40:02 -07:00
committed by GitHub
2 changed files with 18 additions and 13 deletions
+13 -7
View File
@@ -1,13 +1,19 @@
# Redox OS userutils
# Redox OS user and group utilities.
This repository contains utilities for user and group management for Redox. Additional related tools are included.
The `userutils` crate contains the utilities for dealing with users and groups in Redox OS.
They are heavily influenced by UNIX and are, when needed, tailored to specific Redox use cases.
These implementations strive to be as simple as possible drawing particular
inspiration by BSD systems. They are indeed small, by choice.
[![Travis Build Status](https://travis-ci.org/redox-os/userutils.svg?branch=master)](https://travis-ci.org/redox-os/userutils)
**Currently included:**
- `getty`
- `id`
- `login`
- `sudo`
- `whoami`
- `getty`: Used by `init(8)` to open and initialize the TTY line, read a login name and invoke `login(1)`.
- `id`: Displays user identity.
- `login`: Allows users to into the system
- `passwd`: Allows users to modify their passwords.
- `su`: Allows users to substitute identity.
- `sudo`: Enables users to execute a command as another user.
- `whoami`: Display effective user ID.
+5 -6
View File
@@ -1,19 +1,18 @@
//! Redox OS user and group utilities.
//!
//! The `userutils` crate is contains the utilities for dealing with users and groups in Redox OS.
//! They are heavily influenced by UNIX and are, when nedeed, tailored to specific Redox use cases.
//! The `userutils` crate contains the utilities for dealing with users and groups in Redox OS.
//! They are heavily influenced by UNIX and are, when needed, tailored to specific Redox use cases.
//!
//! These implementations strive to be as simple as possible drawing particular
//! inspiration by BSD systems. They are indeed small, by choice.
//!
//! The included utilities are:
//!
//! - `getty`: Used by `init(8)` to open and initialize the TTY line, read a login name,
//! and invoke `login(1)`.
//! - `getty`: Used by `init(8)` to open and initialize the TTY line, read a login name and invoke `login(1)`.
//! - `id`: Displays user identity.
//! - `login`: Allows users to into the system
//! - `login`: Allows users to into the system.
//! - `passwd`: Allows users to modify their passwords.
//! - `su`: Allows users to sustitute identity.
//! - `su`: Allows users to substitute identity.
//! - `sudo`: Enables users to execute a command as another user.
//! - `whoami`: Display effective user ID.