ZVBI

https://github.com/zapping-vbi/zvbi
Admin
Vertical Blanking Interval (VBI) utilities
Tokens:1,237
Snippets:12
Trust Score:2.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Installing the Project - Make

Source: https://github.com/zapping-vbi/zvbi/blob/main/README.md

Installs the compiled binaries, libraries, and other files to the system, typically in standard locations like /usr/local.

```Shell
make install
```

--------------------------------

### Running Project Tests - Make

Source: https://github.com/zapping-vbi/zvbi/blob/main/README.md

Executes the test suite included with the project to verify the build and functionality.

```Shell
make check
```

--------------------------------

### Compiling the Project - Make

Source: https://github.com/zapping-vbi/zvbi/blob/main/README.md

Compiles the source code and builds the project binaries and libraries using the Makefiles generated by the configure script.

```Shell
make
```

--------------------------------

### Configuring the Build - Configure

Source: https://github.com/zapping-vbi/zvbi/blob/main/README.md

Runs the configure script generated by autogen.sh to prepare the Makefiles for compiling the project based on the system's environment and desired options.

```Shell
./configure
```

--------------------------------

### Generating and Configuring in One Step - Autogen

Source: https://github.com/zapping-vbi/zvbi/blob/main/README.md

An optional command that combines running the autogen.sh script and the configure script into a single step.

```Shell
CONFIGURE=1 ./autogen.sh
```

--------------------------------

### Applying LGPL License Header to Source Files

Source: https://github.com/zapping-vbi/zvbi/blob/main/COPYING.md

This snippet provides a template for the license header to be included at the beginning of source files when applying the GNU Lesser General Public License (LGPL). It includes placeholders for the library name, copyright year, and author, states the license terms, disclaims warranty, and provides contact information for the Free Software Foundation.

```Text
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Library General Public License for more details.

You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the 
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 
Boston, MA  02110-1301  USA.
```

--------------------------------

### Generating Configuration Files - Autogen

Source: https://github.com/zapping-vbi/zvbi/blob/main/README.md

Navigates into the cloned zvbi directory and runs the autogen.sh script to generate necessary configuration files for the GNU autotools build system.

```Shell
cd zvbi && ./autogen.sh
```

--------------------------------

### Importing PGP/GPG Keys using gpg

Source: https://github.com/zapping-vbi/zvbi/blob/main/README.md

This command imports PGP/GPG keys from the 'AUTHORS' file into the user's keyring. This is useful for verifying signed emails or commits from the project authors.

```Shell
gpg --import <AUTHORS
```

--------------------------------

### Cloning the zvbi Repository - Git

Source: https://github.com/zapping-vbi/zvbi/blob/main/README.md

Obtains a local copy of the zvbi source code repository from GitHub using the git clone command.

```Shell
git clone https://github.com/zapping-vbi/zvbi.git
```

--------------------------------

### Template for LGPL v2.1 License Header

Source: https://github.com/zapping-vbi/zvbi/blob/main/COPYING.md

This snippet provides a template for the license header that should be included at the beginning of each source file of a library licensed under the LGPL v2.1. It includes placeholders for the library name, copyright year, author, and a pointer to the full license text, emphasizing the lack of warranty.

```text
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year>  <name of author>

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
```

--------------------------------

### Sample Copyright Disclaimer

Source: https://github.com/zapping-vbi/zvbi/blob/main/COPYING.md

This snippet presents a sample text for a copyright disclaimer that an employer or school might sign to relinquish copyright interest in a library developed by an employee or student. It includes placeholders for the organization name, library name, author, and signature details.

```text
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.

<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
```

--------------------------------

### Sample Copyright Disclaimer for LGPL Library

Source: https://github.com/zapping-vbi/zvbi/blob/main/COPYING.md

This snippet is a sample template for a copyright disclaimer that an employer or school might need to sign when a programmer contributes a library under the LGPL. It includes placeholders for the organization name, library name, author, and signature details.

```Text
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.

<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
```
Tokens:
Raw