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