dthelp: Change to ANSI function definitions
[oweals/cde.git] / cde / programs / dtfile / dtfile.config.cpp
1 XCOMM $XConsortium: dtfile.config.cpp /main/4 1996/10/08 11:57:49 mustafa $
2 XCOMM #########################################################################
3 XCOMM  -----------------------------------------------------------------------
4 XCOMM  dtfile.config
5 XCOMM  -------------
6 XCOMM
7 XCOMM (c) Copyright 1996 Digital Equipment Corporation.
8 XCOMM (c) Copyright 1993,1994,1996 Hewlett-Packard Company.
9 XCOMM (c) Copyright 1993,1994,1996 International Business Machines Corp.
10 XCOMM (c) Copyright 1993,1994,1996 Sun Microsystems, Inc.
11 XCOMM (c) Copyright 1996 Novell, Inc. 
12 XCOMM (c) Copyright 1996 FUJITSU LIMITED.
13 XCOMM (c) Copyright 1996 Hitachi.
14 XCOMM (c) Copyright 1993, 1994 Unix System Labs, Inc., a subsidiary of
15 XCOMM     Novell, Inc.
16 XCOMM
17 XCOMM  Configuration file for the dt File Manager.
18 XCOMM
19 XCOMM  This file enables dialogs which can be used to edit
20 XCOMM  file-system specific parameters, for example Access
21 XCOMM  Control Lists for Andrew File System directories.
22 XCOMM  Additional information is in the man page dtfile_config.
23 XCOMM
24 XCOMM  The file consists of two sections.  The first section
25 XCOMM  maps platform-specific information to a platform-independent
26 XCOMM  identifier. There are two fields in the platform-specific
27 XCOMM  portion separated by a colon.  The first field identifies
28 XCOMM  the platform: aix, hpux, sunos.  The second field depends
29 XCOMM  on platform; for aix it is an integer corresponding to the
30 XCOMM  st_vfstype field returned by stat, for hpux it is an integer
31 XCOMM  corresponding to the f_fsid[1] field returned by statfs, for
32 XCOMM  sunos it is a string corresponding to the f_basetype field
33 XCOMM  returned by statvfs.  The platform-independent identifier
34 XCOMM  is given following an equals sign.  The keyword "end" delimits
35 XCOMM  the list of mappings.  For example, to define the "native"
36 XCOMM  file systems on several platforms:
37 XCOMM
38 XCOMM  aix:3       = native
39 XCOMM  hpux:0      = native
40 XCOMM  sunos:ufs   = native
41 XCOMM  decunix:ufs = native
42 XCOMM  end
43 XCOMM
44 XCOMM  The second section of the configuration file provides
45 XCOMM  information needed by File Manager to execute the
46 XCOMM  filesystem-specific dialog. It consists of a list of
47 XCOMM  platform-independent identifiers followed by a colon and
48 XCOMM  two or three fields. Each field consists of a name followed
49 XCOMM  by an equals sign and a string. The three field names are:
50 XCOMM  buttonLabel, which defines a label for a button in the permissions
51 XCOMM  dialog; fsDialog, which defines the path to the program
52 XCOMM  which displays the dialog for editing file-specific properties;
53 XCOMM  and warning, which is optional and defines a warning message to
54 XCOMM  be displayed in permissions dialog. "\n" can be included in the
55 XCOMM  warning text to generate a new line. Continuing the native file
56 XCOMM  system example used above, the following would enable a file-system
57 XCOMM  specific dialog generated by the program /local/bin/modExtAttr:
58 XCOMM
59 XCOMM  native:     buttonLabel  =  Modify extended attributes ...
60 XCOMM              warning      =  Warning:\nExtended attributes may limit your access
61 XCOMM              fsDialog     =  /local/bin/modExtAttr
62 XCOMM
63 XCOMM   Since the button label and warning are visible to users, they must be
64 XCOMM   localized. This is done using the tagged message file
65 XCOMM   format.
66 XCOMM
67 XCOMM  -----------------------------------------------------------------------
68 XCOMM
69
70 XCOMM aix:3       = test
71 XCOMM hpux:0      = test
72 XCOMM sunos:ufs   = test
73 XCOMM decunix:ufs = test
74 end
75
76 afs:    buttonLabel = %|nls-1-#Change AFS ACL ...#|
77         warning     = %|nls-3-#Warning: This is an Andrew File System (AFS) object.\nAccess permissions may be further restricted by the AFS Access Control List (ACL).#|
78         fsDialog    = CDE_INSTALLATION_TOP/bin/dtaclafs
79
80 test:   buttonLabel = %|nls-2-#Display test dialog ...#|
81         fsDialog    = CDE_INSTALLATION_TOP/bin/dtfile_error