steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix docs

db4
Slava Pestov 2008-11-05 04:27:12 -06:00
parent 2239f4fb99
commit affb48a067
2 changed files with 17 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
basis/unix/groups/groups-docs.factor
View File

@ -4,21 +4,15 @@ USING: help.markup help.syntax io.streams.string kernel quotations sequences str
IN: unix.groups
HELP: all-groups
{ $values
{ "seq" sequence } }
{ $values { "seq" sequence } }
{ $description "Returns a sequence of " { $link group } " tuples that are platform-dependent and field for field complete with the Unix " { $link group } " structure." } ;
HELP: effective-group-id
{ $values
{ "string" string } }
{ $values { "string" string } }
{ $description "Returns the effective group id for the current user." } ;
HELP: effective-group-name
{ $values
{ "string" string } }
{ $values { "string" string } }
{ $description "Returns the effective group name for the current user." } ;
HELP: group
@ -46,15 +40,11 @@ HELP: group-struct
{ $description "Returns an alien group struct to be turned into a group tuple by calling subsequent words." } ;
HELP: real-group-id
{ $values
{ "id" integer } }
{ $values { "id" integer } }
{ $description "Returns the real group id for the current user." } ;
HELP: real-group-name
{ $values
{ "string" string } }
{ $values { "string" string } }
{ $description "Returns the real group name for the current user." } ;
HELP: set-effective-group
@ -88,8 +78,9 @@ HELP: with-real-group
{ "string/id" "a string or a group id" } { "quot" quotation } }
{ $description "Sets the real group name and calls the quotation. Restores the current group name on success or on error after the call." } ;
ARTICLE: "unix.groups" "unix.groups"
ARTICLE: "unix.groups" "Unix groups"
"The " { $vocab-link "unix.groups" } " vocabulary contains words that return information about Unix groups."
$nl
"Listing all groups:"
{ $subsection all-groups }
"Returning a passwd tuple:"

33
basis/unix/users/users-docs.factor
View File

@ -4,27 +4,19 @@ USING: help.markup help.syntax io.streams.string kernel quotations sequences str
IN: unix.users
HELP: all-users
{ $values
{ "seq" sequence } }
{ $values { "seq" sequence } }
{ $description "Returns a sequence of high-level " { $link passwd } " tuples that are platform-dependent and field for field complete with the Unix " { $link passwd } " structure." } ;
HELP: effective-username
{ $values
{ "string" string } }
{ $values { "string" string } }
{ $description "Returns the effective username for the current user." } ;
HELP: effective-user-id
{ $values
{ "id" integer } }
{ $values { "id" integer } }
{ $description "Returns the effective username id for the current user." } ;
HELP: new-passwd
{ $values
{ "passwd" passwd } }
{ $values { "passwd" passwd } }
{ $description "Creates a new passwd tuple dependent on the operating system." } ;
HELP: passwd
@ -40,25 +32,19 @@ HELP: passwd>new-passwd
{ $description "A platform-specific conversion routine from a passwd structure to a passwd tuple." } ;
HELP: real-username
{ $values
{ "string" string } }
{ $values { "string" string } }
{ $description "The real username of the current user." } ;
HELP: real-user-id
{ $values
{ "id" integer } }
{ $values { "id" integer } }
{ $description "The real user id of the current user." } ;
HELP: set-effective-user
{ $values
{ "string/id" "a string or a user id" } }
{ $values { "string/id" "a string or a user id" } }
{ $description "Sets the current effective user given a username or a user id." } ;
HELP: set-real-user
{ $values
{ "string/id" "a string or a user id" } }
{ $values { "string/id" "a string or a user id" } }
{ $description "Sets the current real user given a username or a user id." } ;
HELP: user-passwd
@ -100,8 +86,9 @@ HELP: with-real-user
set-effective-user
} related-words
ARTICLE: "unix.users" "unix.users"
ARTICLE: "unix.users" "Unix users"
"The " { $vocab-link "unix.users" } " vocabulary contains words that return information about Unix users."
$nl
"Listing all users:"
{ $subsection all-users }
"Returning a passwd tuple:"