Browse Source

man: add pkgconf-personality(5)

William Pitcock 1 year ago
parent
commit
41f8031533
1 changed files with 89 additions and 0 deletions
  1. 89
    0
      man/pkgconf-personality.5

+ 89
- 0
man/pkgconf-personality.5 View File

@@ -0,0 +1,89 @@
1
+.\" Copyright (c) 2018 pkgconf authors (see AUTHORS).
2
+.\"
3
+.\" Permission to use, copy, modify, and/or distribute this software for any
4
+.\" purpose with or without fee is hereby granted, provided that the above
5
+.\" copyright notice and this permission notice appear in all copies.
6
+.\"
7
+.\" This software is provided 'as is' and without any warranty, express or
8
+.\" implied.  In no event shall the authors be liable for any damages arising
9
+.\" from the use of this software.
10
+.Dd July 19, 2018
11
+.Dt PKGCONF-PERSONALITY 5
12
+.Os
13
+.Sh NAME
14
+.Nm file.personality
15
+.Nd pkgconf cross-compile personality file format
16
+.Sh DESCRIPTION
17
+pkgconf cross-compile personality files provide a useful mechanism for storing
18
+various information about system toolchains.
19
+Information stored by
20
+.Nm .personality
21
+files include information about paths used by a cross-compile toolchain, such as
22
+the sysroot directory and default include and library paths.  pkgconf uses this
23
+information to determine what information is necessary to use libraries.
24
+.\"
25
+.Ss FILE SYNTAX
26
+The
27
+.Nm .personality
28
+file follows a format inspired by RFC822.
29
+Comments are prefixed by a pound sign, hash sign or octothorpe (#), and variable
30
+assignment is similar to POSIX shell.
31
+Properties are defined using RFC822-style stanzas.
32
+.\"
33
+.Ss PROPERTIES
34
+.\"
35
+Properties are set using RFC822-style stanzas which consist of a keyword, followed
36
+by a colon (:) and then the value the property should be set to.
37
+Variable substitution is always performed regardless of property type.
38
+.Pp
39
+There are two types of property:
40
+.\"
41
+.Bl -tag -width indent
42
+.\"
43
+.It Literal
44
+The property will be set to the text of the value.
45
+.\"
46
+.It Fragment List
47
+The property will be set to a list of fragments parsed from the text.
48
+The input text must be in a format that is suitable for passing to a POSIX
49
+shell without any shell expansions after variable substitution has been done.
50
+.\"
51
+.El
52
+.Ss PROPERTY KEYWORDS
53
+.Bl -tag -width indent
54
+.\"
55
+.It Triplet
56
+The triplet used by the cross-compile toolchain.
57
+(mandatory; literal)
58
+.It SysrootDir
59
+The directory used by the system root of the cross-compile toolchain.
60
+(mandatory; literal)
61
+.It DefaultSearchPaths
62
+A list of directories to look for
63
+.Xr pc 5
64
+files in.
65
+(mandatory; fragment list)
66
+.It SystemIncludePaths
67
+A list of directories that are included by default in the search path for
68
+include files.
69
+(mandatory; fragment list)
70
+.It SystemLibraryPaths
71
+A list of directories that are included by default in the search path for
72
+libraries.
73
+(mandatory; fragment list)
74
+.\"
75
+.Sh EXAMPLES
76
+An example .personality file:
77
+.Bd -literal
78
+# This is a comment
79
+Triplet: x86_64-pc-linux-gnu
80
+SysrootDir: /home/kaniini/sysroot/x86_64-pc-linux-gnu
81
+DefaultSearchPaths: /home/kaniini/sysroot/x86_64-pc-linux-gnu/lib/pkgconfig \\
82
+  /home/kaniini/sysroot/x86_64-pc-linux-gnu/share/pkgconfig
83
+SystemIncludePaths: /home/kaniini/sysroot/x86_64-pc-linux-gnu/include
84
+SystemLibraryPaths: /home/kaniini/sysroot/x86_64-pc-linux-gnu/lib
85
+.Ed
86
+.Sh SEE ALSO
87
+.Xr pkgconf 1 ,
88
+.Xr pkg.m4 7 ,
89
+.Xr pc 5