Imported Upstream version 2.10
[debian/cpmtools] / cpmchattr.1
1 .TH CPMCHATTR 1 "July 6, 2009" "CP/M tools" "User commands"
2 .SH NAME \"{{{roff}}}\"{{{
3 cpmchattr \- change file attributes on CP/M files
4 .\"}}}
5 .SH SYNOPSIS \"{{{
6 .ad l
7 .B cpmchattr
8 .RB [ \-f
9 .IR format ]
10 .I image
11 .I attrib
12 .I file-pattern
13 \&...
14 .ad b
15 .\"}}}
16 .SH DESCRIPTION \"{{{
17 \fBCpmchattr\fP changes the file attributes for files on CP/M disks.
18 .\"}}}
19 .SH OPTIONS \"{{{
20 .IP "\fB\-f\fP \fIformat\fP"
21 Use the given CP/M disk \fIformat\fP instead of the default format.
22 .IP "\fIattrib\fP"
23 Set the file attributes as given.
24 .\"}}}
25 .SH "FILE ATTRIBUTES" \"{{{
26 The file attribute string can contain the characters
27 1,2,3,4,r,s,a,n and m.
28 The meanings of these are:
29 .TP
30 .B 1-4
31 The CP/M "user attributes" F1-F4.  CP/M does not assign any
32 meaning to these attributes, though MP/M does.
33 .TP
34 .B r
35 The file is read-only.  This is the same as using
36 .I cpmchmod(1)
37 to revoke write permissions.
38 .TP
39 .B s
40 The file is a system file.  This attribute can also be set by
41 .I cpmchmod(1).
42 .TP
43 .B a
44 The file has been backed up.
45 .TP
46 .B n
47 Reset all attributes to zero.  So the string "n1r" resets all attributes and
48 then sets F1 and Read-Only.
49 .TP
50 .B m
51 Attributes after an m are unset rather than set.  The string "12m34" sets
52 atttributes F1 and F2, and unsets F3 and F4.
53 .\"}}}
54 .SH "RETURN VALUE" \"{{{
55 Upon successful completion, exit code 0 is returned.
56 .\"}}}
57 .SH ERRORS \"{{{
58 Any errors are indicated by exit code 1.
59 .\"}}}
60 .SH FILES \"{{{
61 ${prefix}/share/diskdefs        CP/M disk format definitions
62 .\"}}}
63 .SH AUTHORS \"{{{
64 This program is copyright 1997\(en2008 Michael Haardt
65 <michael@moria.de> and copyright 2000, 2001 John Elliott
66 <jce@seasip.demon.co.uk>.
67 .PP
68 This program is free software; you can redistribute it and/or modify
69 it under the terms of the GNU General Public License as published by
70 the Free Software Foundation; either version 3 of the License, or
71 (at your option) any later version.
72 .PP
73 This program is distributed in the hope that it will be useful,
74 but WITHOUT ANY WARRANTY; without even the implied warranty of
75 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
76 GNU General Public License for more details.
77 .PP
78 You should have received a copy of the GNU General Public License along
79 with this program.  If not, write to the Free Software Foundation, Inc.,
80 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
81 .\"}}}
82 .SH "SEE ALSO" \"{{{
83 .IR cpmls (1),
84 .IR cpmchmod (1),
85 .IR cpm (5)
86 .\"}}}