Return to mkproject.n CVS log

Up to [CSRG BSD Unix] / 43BSDReno / share / doc / ucs / spms

Annotation of 43BSDReno/share/doc/ucs/spms/mkproject.n, revision 1.1.1.1

1.1       root        1: .TH MKPROJECT 1P "22 June 1983"
                      2: .UC 4
                      3: .SH NAME
                      4: mkproject \- make a project root directory
                      5: .SH SYNOPSIS
                      6: .B mkproject
                      7: [{+\^\-}\fBd\fR]
                      8: [{+\^\-}\fBN\fR alias]
                      9: [{+\^\-}\fBT\fR type[,type ...]]
                     10: projectname ...
                     11: .SH DESCRIPTION
                     12: .I Mkproject
                     13: creates a directory called
                     14: .I projectname.
                     15: The directory is known as a
                     16: .I project root directory
                     17: and is the focus for a project.
                     18: Standard entries, `.', for the directory itself, `..', for its parent,
                     19: and `...' for the project link directory, are made automatically.
                     20: After the directory has been created,
                     21: .I mkproject
                     22: prompts the user for a line describing the purpose of the project.
                     23: .PP
                     24: If the name of the directory conflicts with an existing project,
                     25: an alternative alias for the project may be specified via the
                     26: .B \-N
                     27: option. However, even if this option is used, the name of the directory
                     28: will be recognized as a project unless it is disguised as a regular
                     29: pathname. For example, to create another project called `spms'
                     30: with alias `newspms', type:
                     31: .PP
                     32:                mkproject  \-N newspms  ./spms
                     33: .PP
                     34: .I Mkproject
                     35: may also be used to convert an existing regular directory to a
                     36: project root directory.
                     37: .PP
                     38: .I Mkproject
                     39: requires write permission in the parent directory.
                     40: .SH OPTIONS
                     41: .IP "\fB+d\fR"
                     42: Change the description of an existing project.
                     43: .IP "\fB\-d\fR"
                     44: Turn
                     45: .B off
                     46: prompting for the description of a new project.
                     47: .IP "\fB\+N\fI alias\fR"
                     48: Change the alias of the project.
                     49: .IP "\fB\-N\fI alias\fR"
                     50: Specify an alternative alias for a new project.
                     51: .IP "\fB\+T\fI type\fR"
                     52: Add a type label to an existing project root directory. If the type label
                     53: already exists but has a different priority, then it must be removed using
                     54: the
                     55: .I rmproject
                     56: command.
                     57: .IP "\fB\-T\fI type\fR"
                     58: Specify a type label for a new project root directory.
                     59: .SH FILES
                     60: .ta \w'..._temp'u+.5i
                     61: \&...  Project link directory.
                     62: .br
                     63: \&..._temp     Temporary project link directory.
                     64: .DT
                     65: .SH LIMITATIONS
                     66: Project descriptions can be no longer than 128 characters.
                     67: .SH "SEE ALSO"
                     68: mkdir(1), rmproject(1P)
                     69: .SH DIAGNOSTICS
                     70: The error message, ``mkproject: \fIproject\fR/... temporarily unavailable'',
                     71: indicates that a `..._temp' temporary project link directory exists. This could
                     72: be because another user is altering the project link directory, or because a
                     73: system crash terminated
                     74: .I mkproject
                     75: prematurely. If the latter case, then removing the temporary file will fix
                     76: the problem.
                     77: .PP
                     78: Exit status 0 is normal. Exit status 1 indicates an error.
                     79: .SH AUTHOR
                     80: Peter J. Nicklin
                     81: .SH BUGS
                     82: The root project, `^', cannot have an alternative alias.
                     83: .PP
                     84: Directory aliases must not include the characters `:' or `|'.
                     85: .PP
                     86: Type labels must not include the characters `:' or `/'.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.