New upstream version 2.20
[debian/cpmtools] / cpmchattr.1
1 .TH CPMCHATTR 1 "October 25, 2014" "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 "\fB\-T\fP \fIlibdsk-type\fP"
23 libdsk driver type, e.g. \fBtele\fP for Teledisk images or \fBraw\fP for raw images 
24 (requires building cpmtools with support for libdsk).
25 .IP "\fIattrib\fP"
26 Set the file attributes as given.
27 .\"}}}
28 .SH "FILE ATTRIBUTES" \"{{{
29 The file attribute string can contain the characters
30 1,2,3,4,r,s,a,n and m.
31 The meanings of these are:
32 .TP
33 .B 1-4
34 The CP/M "user attributes" F1-F4.  CP/M does not assign any
35 meaning to these attributes, though MP/M does.
36 .TP
37 .B r
38 The file is read-only.  This is the same as using
39 .I cpmchmod(1)
40 to revoke write permissions.
41 .TP
42 .B s
43 The file is a system file.  This attribute can also be set by
44 .I cpmchmod(1).
45 .TP
46 .B a
47 The file has been backed up.
48 .TP
49 .B n
50 Reset all attributes to zero.  So the string "n1r" resets all attributes and
51 then sets F1 and Read-Only.
52 .TP
53 .B m
54 Attributes after an m are unset rather than set.  The string "12m34" sets
55 atttributes F1 and F2, and unsets F3 and F4.
56 .\"}}}
57 .SH "RETURN VALUE" \"{{{
58 Upon successful completion, exit code 0 is returned.
59 .\"}}}
60 .SH ERRORS \"{{{
61 Any errors are indicated by exit code 1.
62 .\"}}}
63 .SH ENVIRONMENT \"{{{
64 CPMTOOLSFMT     Default format
65 .\"}}}
66 .SH FILES \"{{{
67 ${prefix}/share/diskdefs        CP/M disk format definitions
68 .\"}}}
69 .SH AUTHORS \"{{{
70 This program is copyright 1997\(en2012 Michael Haardt
71 <michael@moria.de> and copyright 2000, 2001, 2011 John Elliott
72 <jce@seasip.demon.co.uk>.
73 .PP
74 This program is free software; you can redistribute it and/or modify
75 it under the terms of the GNU General Public License as published by
76 the Free Software Foundation; either version 3 of the License, or
77 (at your option) any later version.
78 .PP
79 This program is distributed in the hope that it will be useful,
80 but WITHOUT ANY WARRANTY; without even the implied warranty of
81 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
82 GNU General Public License for more details.
83 .PP
84 You should have received a copy of the GNU General Public License along
85 with this program.  If not, write to the Free Software Foundation, Inc.,
86 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
87 .\"}}}
88 .SH "SEE ALSO" \"{{{
89 .IR cpmls (1),
90 .IR cpmchmod (1),
91 .IR cpm (5)
92 .\"}}}