summaryrefslogtreecommitdiff
path: root/pinyadmin/doc
diff options
context:
space:
mode:
authorBryan Bishop <kanzure@gmail.com>2010-10-29 19:46:24 -0500
committerBryan Bishop <kanzure@gmail.com>2010-10-29 19:46:24 -0500
commit7786ce2a332b0eba4b3ca7c57f906a32e8715da3 (patch)
tree5a9fe32b69a93f41ae2ac82a50788fe50c0d86fb /pinyadmin/doc
parent413373be9ab30eb21b564cdc180cb2dcda77bfeb (diff)
downloadpiny-code-7786ce2a332b0eba4b3ca7c57f906a32e8715da3.tar.gz
piny-code-7786ce2a332b0eba4b3ca7c57f906a32e8715da3.zip
Starting repo cleanup to make this not so awful
Diffstat (limited to 'pinyadmin/doc')
-rw-r--r--pinyadmin/doc/addaccess.latex17
-rw-r--r--pinyadmin/doc/newrepo.latex15
-rw-r--r--pinyadmin/doc/newuser.latex16
-rw-r--r--pinyadmin/doc/pinyconfig.latex17
-rw-r--r--pinyadmin/doc/pinyshell.latex19
-rw-r--r--pinyadmin/doc/rebuildrepo.latex16
-rw-r--r--pinyadmin/doc/rmaccess.latex22
-rw-r--r--pinyadmin/doc/rmrepo.latex14
8 files changed, 136 insertions, 0 deletions
diff --git a/pinyadmin/doc/addaccess.latex b/pinyadmin/doc/addaccess.latex
new file mode 100644
index 0000000..a8c29f9
--- /dev/null
+++ b/pinyadmin/doc/addaccess.latex
@@ -0,0 +1,17 @@
+\usepackage{latex2man}
+
+\begin{Name}{1piny}{addaccess}{Piny Team}{Piny}{addaccess}
+
+\Prog{addaccess} - allow access to a repository
+
+\section{Synopsis}
+
+\Prog{addaccess} \Arg{reponame} \Arg{username} \Dots
+
+\section{Description}
+
+The \Prog{addaccess} command grants users write access to a repository.
+It may only be run by the owner of the repository.
+
+For each \Arg{username} passed on the command line, \Prog{addaccess} will grant write permission to the repository.
+Other users are not affected.
diff --git a/pinyadmin/doc/newrepo.latex b/pinyadmin/doc/newrepo.latex
new file mode 100644
index 0000000..a708b6c
--- /dev/null
+++ b/pinyadmin/doc/newrepo.latex
@@ -0,0 +1,15 @@
+\usepackage{latex2man}
+
+\begin{Name}{1piny}{newrepo}{Piny Team}{Piny}{newrepo}
+
+\Prog{newrepo} - create a new repository
+
+\section{Synopsis}
+
+\Prog{newrepo} \Arg{reponame}
+
+\section{Description}
+
+The \Prog{newrepo} command creates a new repository with the given name.
+The current user is set as the owner of the new repository.
+No other users are given access to the new repository.
diff --git a/pinyadmin/doc/newuser.latex b/pinyadmin/doc/newuser.latex
new file mode 100644
index 0000000..721d468
--- /dev/null
+++ b/pinyadmin/doc/newuser.latex
@@ -0,0 +1,16 @@
+\usepackage{latex2man}
+
+\begin{Name}{8piny}{newuser}{Piny Team}{Piny}{createuser}
+
+\Prog{newuser} - add a piny user
+
+\section{Synopsis}
+
+\Prog{newuser}
+
+\Prog{createuser}
+
+\section{Description}
+
+The \Prog{newuser} program is an interactive script which walks the user through the process of creating a new Piny account.
+Normally it is set as the shell of a passwordless user such as "newuser" or "createuser", so that users can create accounts without any assistance from a sysadmin.
diff --git a/pinyadmin/doc/pinyconfig.latex b/pinyadmin/doc/pinyconfig.latex
new file mode 100644
index 0000000..4908dbb
--- /dev/null
+++ b/pinyadmin/doc/pinyconfig.latex
@@ -0,0 +1,17 @@
+\usepackage{latex2man}
+
+\begin{Name}{1piny}{pinyconfig}{Piny Team}{Piny}{pinyconfig}
+
+\Prog{pinyconfig} - change tweakables on a repo
+
+\section{Synopsis}
+
+\Prog{pinyconfig} \Arg{reponame} \Arg{tweakable} \oArg{value}
+
+\section{Description}
+
+The \Prog{pinyconfig} command reads and writes tweakables for a repo.
+
+When run, it prints the value of the tweakable for the repo named.
+If a value was passed, it sets the value of the tweakable to that value
+before printing it.
diff --git a/pinyadmin/doc/pinyshell.latex b/pinyadmin/doc/pinyshell.latex
new file mode 100644
index 0000000..481ddf3
--- /dev/null
+++ b/pinyadmin/doc/pinyshell.latex
@@ -0,0 +1,19 @@
+\usepackage{latex2man}
+
+\begin{Name}{8piny}{pinyshell}{Piny Team}{Piny}{pinyshell}
+
+\Prog{pinyshell} - a restricted shell
+
+\section{Synopsis}
+
+\Prog{pinyshell}
+
+\section{Description}
+
+\Prog{pinyshell} is just another way to invoke \Cmd{1}{rbash}; the separate name is used for accounting purposes within the piny infrastructure.
+
+Users which should be managed by the Piny infrastructure should have \Prog{pinyshell} as their shell.
+
+\section{See Also}
+
+\Cmd{1}{rbash}
diff --git a/pinyadmin/doc/rebuildrepo.latex b/pinyadmin/doc/rebuildrepo.latex
new file mode 100644
index 0000000..a2e0935
--- /dev/null
+++ b/pinyadmin/doc/rebuildrepo.latex
@@ -0,0 +1,16 @@
+\usepackage{latex2man}
+
+\begin{Name}{8piny}{rebuildrepo}{Piny Team}{Piny}{rebuildrepo}
+
+\Prog{rebuildrepo} - rebuild a repo configuration
+
+\section{Synopsis}
+
+\Prog{rebuildrepo} \Arg{reponame} \Dots
+
+\section{Description}
+
+The \Prog{rebuildrepo} command rewrites all of the configuration files for
+the given repo and adjusts ownership and group membership of its files to a
+normalized state. It is needed to propagate certain kinds of changes;
+normally only the system administrator should run it.
diff --git a/pinyadmin/doc/rmaccess.latex b/pinyadmin/doc/rmaccess.latex
new file mode 100644
index 0000000..41f7af4
--- /dev/null
+++ b/pinyadmin/doc/rmaccess.latex
@@ -0,0 +1,22 @@
+\usepackage{latex2man}
+
+\begin{Name}{1piny}{rmaccess}{Piny Team}{Piny}{rmaccess}
+
+\Prog{rmaccess} - remove access to a repository
+
+\section{Synopsis}
+
+\Prog{rmaccess} \Arg{reponame} \Arg{username} \Dots
+
+\section{Description}
+
+The \Prog{rmaccess} command denies users write access to a repository.
+It may only be run by the owner of the repository.
+
+For each \Arg{username} passed on the command line, \Prog{addaccess} will deny write permission to the repository.
+Other users are not affected.
+
+\section{Bugs}
+
+You cannot deny write permission to the owner of the repository.
+If you try, the program will appear to succeed, but the owner will still be able to make changes.
diff --git a/pinyadmin/doc/rmrepo.latex b/pinyadmin/doc/rmrepo.latex
new file mode 100644
index 0000000..12b58df
--- /dev/null
+++ b/pinyadmin/doc/rmrepo.latex
@@ -0,0 +1,14 @@
+\usepackage{latex2man}
+
+\begin{Name}{1piny}{rmrepo}{Piny Team}{Piny}{rmrepo}
+
+\Prog{rmrepo} - delete a repository
+
+\section{Synopsis}
+
+\Prog{rmrepo} \Arg{reponame} \Dots
+
+\section{Description}
+
+The \Prog{rmrepo} command permanently destroys the repository with the given name.
+The current user must be the owner of the repository.