diff options
| -rw-r--r-- | share/man/man1/meta-rip.1 | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/share/man/man1/meta-rip.1 b/share/man/man1/meta-rip.1 new file mode 100644 index 0000000..94d9296 --- /dev/null +++ b/share/man/man1/meta-rip.1 @@ -0,0 +1,58 @@ +.\" Copyright (c) 2023 Ian Marco Moffett and the VegaOS 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 VegaOS 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. +.Dd October 4, 2023 +.Dt META-RIP 1 +.Os +.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 +$Vega$: 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 |