.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ORIGAMI 1"
.TH ORIGAMI 1 "2017-01-13" "1.2.7+really0.7.4-1.1" ""
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Origami \- command\-line management tool for Folding @ Home clients.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
origami {install | archive | restore | erase | name | status | monitor | proxy | start | stop | version | help} [<options>...]
.PP
origami {deploy | network-archive | network-restore | network-name | network-monitor | network-name | network-start | network\-stop} [<options>...]
.PP
origami help
.PP
origami version
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Origami allows you to install, monitor, archive or restore Folding @ Home data
on your local machine.  It also allows for central deployment, monitoring,
archiving, restoration and updating the username and team data via the network
to ssh-accessible machines.
.PP
Origami supports cron-based scheduling, 32bit or 64bit and network proxy settings.
Install Stanfords Folding @ Home client to a single machine or network of machines.
.SH "COMMAND-LINE ACTIONS"
.IX Header "COMMAND-LINE ACTIONS"
The first argument which does not begin with a hyphen (\*(L"\-\*(R") is considered to be
an action that the program should perform.  If an action is not specified
\&\fBOrigami\fR will display the help output.
.PP
The following actions are available to the local machine:
.IP "\fBinstall\fR" 8
.IX Item "install"
Install Folding @ Home to the local machine.  This action will create a
dedicated user, storage location for Folding @ Home data, startup
script and request a work unit.
.IP "\fBdeploy\fR" 8
.IX Item "deploy"
Install Folding @ Home to remote machines as listed in the ~/.origamirc file.
This action will create a dedicated user, storage location for Folding @ Home
data, startup script and request a work unit on the remote machine.  \s-1SSH\s0
access as the root user is required for the deploy action.
.IP "\fBarchive\fR" 8
.IX Item "archive"
Archive Folding @ Home data for the local Folding @ Home client.  This action 
will stop the Folding @ Home client, archive the current progress into a
<hostname>\-<date>.tar.bz2 format and store the data in ~/.origami/.
.IP "\fBnetwork-archive\fR" 8
.IX Item "network-archive"
Archive Folding @ Home data on the remote Folding @ Home client as listed in the
~/.origamirc.  This action will stop the Folding @ Home client, archive the 
current progress into a <hostname>\-<date>.tar.bz2 format and store the data in ~/.origami/.
.IP "\fBrestore\fR" 8
.IX Item "restore"
Restore Folding @ Home data on the local machine.  This action will
require previously archived data (as generated by the archive action).
.IP "\fBnetwork-restore\fR" 8
.IX Item "network-restore"
Restore Folding @ Home data on the remote Folding @ Home clients as listed in the
~/.origamirc.  This action will require previously archived data (as generated by
the network-archive action).
.IP "\fBerase\fR" 8
.IX Item "erase"
Erase current Folding @ Home installation.  Anything generated by the
install function will be removed and all Folding @ Home progress will
be lost.
.IP "\fBname\fR" 8
.IX Item "name"
Update the username and team information for the local Folding @ Home
client.  It is generally preferred to define username and team at
installation with the install action.
.IP "\fBnetwork-name\fR" 8
.IX Item "network-name"
Update the username and team information for the remote Folding @ Home
clients.  It is generally preferred to define username and team at
installation with the deploy action.
.IP "\fBstatus|monitor\fR" 8
.IX Item "status|monitor"
Display the current progress of the local Folding @ Home client.
.IP "\fBnetwork\-status|network\-monitor\fR" 8
.IX Item "network-status|network-monitor"
Disploy the current progress of the remote Folding @ Home clients as listed
in the ~/.origamirc.
.IP "\fBproxy\fR" 8
.IX Item "proxy"
Update the proxy settings for the local Folding @ Home client.  This
action requires a port and hostname.  It is generally preferred to
define the proxy port and hostname at installation with the install
action.
.IP "\fBstart\fR" 8
.IX Item "start"
Start the local Folding @ Home client.  (This calls /etc/init.d/origami start)
.IP "\fBnetwork-start\fR" 8
.IX Item "network-start"
Start the remote Folding @ Home clients as listed in the ~/.origamirc.
.IP "\fBstop\fR" 8
.IX Item "stop"
Stop the local Folding @ Home client.  (This calls /etc/init.d/origami stop)
.IP "\fBnetwork-stop\fR" 8
.IX Item "network-stop"
Stop the remote Folding @ Home clients as listed in the ~/.origamirc.
.IP "\fBversion\fR" 8
.IX Item "version"
Display the Origami version.
.IP "\fBhelp\fR" 8
.IX Item "help"
Display the Origami help output.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-u|\-\-user=\f(BIvalue\fB\fR" 4
.IX Item "-u|--user=value"
Define the \s-1USERNAME\s0 that Folding @ Home data should credit.  Default is Anonymous.
.IP "\fB\-t|\-\-team=\f(BIvalue\fB\fR" 4
.IX Item "-t|--team=value"
Define the \s-1TEAM NUMBER\s0 that Folding @ Home data should credit.  Default is 0.
.IP "\fB\-c|\-\-cron=\f(BIboolean\fB\fR" 4
.IX Item "-c|--cron=boolean"
Activate cron scheduling for the Folding @ Home client.  Default is off (0).
.IP "\fB\-p|\-\-proc=\f(BIvalue\fB\fR" 4
.IX Item "-p|--proc=value"
Define i386 or amd64 Folding @ Home client.  Default is i386.
.IP "\fB\-P|\-\-port=\f(BIvalue\fB\fR" 4
.IX Item "-P|--port=value"
Define the port to be used in conjunction with a proxy.  Default is 8080.
.IP "\fB\-H|\-\-host=\f(BIvalue\fB\fR" 4
.IX Item "-H|--host=value"
Define the \s-1IP\s0 or hostname to be used in conjunction with a proxy.  Default is localhost.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.IP "\fBorigami install\fR" 4
.IX Item "origami install"
This example will install the Folding @ Home client to the local machine, reporting data
as the default Anonymous user and default 0 Team.
.IP "\fBorigami install \-u Joe \-t 45104\fR" 4
.IX Item "origami install -u Joe -t 45104"
This example will install the Folding @ Home client to the local machine, reporting data
as the \fBJoe\fR user as part of the 45104 (TeamUbuntu) Team.
.IP "\fBorigami deploy \-u Joe \-t 45104\fR" 4
.IX Item "origami deploy -u Joe -t 45104"
This example will install the Folding @ Home client to all machines listed in the ~/.origamirc
file, reporting data as the \fBJoe\fR user as part of the 45104 (TeamUbuntu) Team.
.IP "\fBorigami install \-u Joe \-t 45104 \-p amd64 \-c1\fR" 4
.IX Item "origami install -u Joe -t 45104 -p amd64 -c1"
This example will install the Folding @ home client to the local machine, reporting data
as the \fBJoe\fR user as part of the 45104 (TeamUbuntu) Team, using the amd64 Folding @ Home client
and toggling the cron option to auto-stop between the hours of 8:00am and 5:00pm.
.IP "\fBorigami network-status\fR" 4
.IX Item "origami network-status"
This example will display the current status of the Folding @ Home clients on all machines
listed in the ~/.origamirc file.
.SH "BUGS"
.IX Header "BUGS"
To find a list of current bugs, or to report a bug new bug please see https://bugs.launchpad.net/origami.
.SH "AUTHORS"
.IX Header "AUTHORS"
\&\fBOrigami\fR was written by Christer Edwards <christer.edwards@ubuntu.com>. 
This manual page was written by Christer Edwards <christer.edwards@ubuntu.com>.
.PP
Both are released under the \s-1GNU\s0 General Public License, version 2 or later.