aboutsummaryrefslogtreecommitdiff
path: root/share/man/man1/meta-rip.1
blob: 30d1835668e40928bca95be32c12cde4c9fef11e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
.\" Copyright (c) 2024 Ian Marco Moffett and the Osmora Team.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions are met:
.\"
.\" 1. Redistributions of source code must retain the above copyright notice,
.\"    this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of Hyra nor the names of its
.\"    contributors may be used to endorse or promote products derived from
.\"    this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
.\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
.\" LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.TH META-RIP 1 2023-10-04 "Osmora" "Hyra Operating System"
.Sh NAME
.Nm meta-rip - rip metadata from object file
.Sh SYNOPSIS

.Bd -literal
meta-rip [FILE]
.Ed

.Sh DESCRIPTION
This utility rips metadata from the .meta.note section of
an object file that contains the following format:

.Bd -literal
$Hyra$: Filename, Author Of Module, Description Of Module
  \\
   Cookie (always first)
.Ed

Example assembly C code that uses inline assembly to embed
a meta string:

.Bd -literal
#define __KERNEL_META(meta_str)                    \\
    __asm__ __volatile__(".section .meta.note\\n"   \\
            ".align 4\\n"                           \\
            ".string \\"" meta_str "\\"\\n"           \\
            ".previous"                            \\
    )
.Ed

.Sh AUTHORS
.An Ian Moffett Aq Mt ian@osmora.org