C_Linux

A set of C-Unix examples showing usage of Unix syscall related to processes, threads, filesystem

🧠 Founder & Developer

Giuseppe Pedone (Unix69)

📓 Table of Contents

Navigation index to fast explore the content:

• Examples
• Getting Started
• License
• Contributing
  • Fork Project
  • Pull Request
  • Issue
  • Code Of Conduct
• FAQ
• Authors
• Contacts

Getting Started 🚀

Table of Contents

Follow these steps to get, install and set up the project and generate the documentation:

• 1 - Verify Prerequisites and Dependencies
  C_Linux needs to run on hosts equipped with specific hardware and software.
  So read carefully the prerequisites to respect and the dependencies to satisfy.

• 2 - Get and Install
  Get the project package, then follow the installation procedure to correctly set up the environment.

• 3 - Build
  Compile the source code and generate executable artifacts according to your build configuration.

• 4 - Setup and Configure
  Adjust configuration files and system parameters required to customize the project behaviour.

• 5 - Run
  Start the project using the provided startup script or command sequence.

• 6 - Uninstall
  Remove the project and all its dependencies from the system safely and completely.

💻 Prerequisites

Before building or running the project, make sure you satisgy the prerequisites to run the project:

• Operating System: GNU/Linux, Windows
• Software Dependencies: GitHub, Doxygen, GNU Make, GNU C Compiler `

📦 Dependencies

Before building and generating documentation with C_Linux, make sure the following dependencies are installed on your system:

• GitHub — Optional.
  Even if you don’t have a GitHub account or Git installed, you can still generate documentation locally.
  However, having a GitHub account and using Git is recommended for project deployment and version control.

• Doxygen — Mandatory.
  Used to generate documentation from source code and Markdown files.
  The project won’t build documentation without it.

• GNU Make — Mandatory.
  Required to run automated build and documentation generation tasks.
  Used in this project to simplify commands such as:

  make doc

  and

  make clean

Below are the detailed installation steps for each dependency, both on Unix/Linux and Windows systems.

Install GitHub / Git

🐧 On GNU/Linux

sudo apt update
sudo apt install git

After installation, verify that Git is available:

git --version

To link your project to GitHub, create a free account at:
👉 https://github.com/signup

Then configure Git with your account details:

git config --global user.name "Your Name"
git config --global user.email "you@example.com"

On Windows

1. Download Git for Windows from:
   👉 https://git-scm.com/download/win

2. Run the installer and follow the setup wizard (leave default options checked).

3. After installation, open Git Bash and verify:

   git --version
   

4. Optionally create a GitHub account at
   👉 https://github.com/signup

Install Doxygen

🐧 On GNU/Linux

sudo apt update
sudo apt install doxygen graphviz

Verify the installation:

doxygen --version

Optionally, you can generate a sample configuration file with:

doxygen -g

On Windows

1. Download the Windows installer from:
   👉 https://www.doxygen.nl/download.html

2. Run the .exe file and follow the setup wizard.

3. After installation, open Command Prompt and check:

   doxygen --version
   

4. To enable UML and graphs, install Graphviz as well:
   👉 https://graphviz.org/download/

Install GNU Make

🐧 On GNU/Linux

GNU Make is usually preinstalled. Check it with:

make --version

If missing, install it via:

sudo apt update
sudo apt install make

On Windows

You can install GNU Make in one of these ways:

✅ Option 1: Using MinGW

1. Download and install MinGW from:
   👉 https://www.mingw-w64.org/
2. During installation, select the “mingw32-make” package.
3. Add MinGW’s bin directory to your system PATH.
4. Verify installation:

   mingw32-make --version
   

You can then rename or alias it to make for convenience.

✅ Option 2: Using Chocolatey (recommended if available)

If you have Chocolatey package manager installed:

choco install make

💡 Dependencies Verification

After installing all dependencies, verify them with:

git --version
doxygen --version
make --version

If all commands return valid version numbers, you’re ready to build and document your project 🎉

💡 Tip: You can also run the doxygen.sh script from the root directory.
It will automatically:

• Check that Doxygen is installed. If it is not installed, the doxygen.sh script will fail ❌ and do not proceed.
• Otherwhise it: - Generate a base Doxyfile if missing into the root directory.

•    - Apply the custom configuration for **C_Linux** on the Doxyfile
  

⭐ Installation

To install the project follow this setps:

A. You can download the repository from GitHub: ⬇️ https://github.com/Unix69/README-Template/archive/refs/heads/main.zip

manually or by opening a terminal into your project destination directory, and running the following commands:

  mkdir project-root #create the project root directory
  cd project-root #change to the project root directory
  wget https://github.com/Unix69/README-Template/archive/refs/heads/master.zip #make an http get request to get the project repository ** zip file ** 
  unzip master.zip #unzip the project master.zip file
  cp -R master/ ./ #copy all files recursively from the unziped master directory to your project root directory
  rm -rf master master.zip #remove the unziped master directory and master.zip file
  

B. You can clone the repository from GitHub if you have Git installed by running the following commands:

  mkdir project-root #create the project root directory
  cd project-root #change to the project root directory
  clone https://github.com/Unix69/C_Linux.git #clone the project repository 
  cp -R C_Linux/ ./ #copy all files recursively from the C_Linux directory to your project root directory
  rm -rf C_Linux #remove the C_Linux directory. 
  

⬇️ Download ZIP
🐙 View on GitHub

🛠️ Build

To build the project generate a custom or standard Doxyfile:

A. Custom Doxyfile - Doxygen Script: running the doxygen.sh script from the root directory;

    ./doxygen.sh  
  

or by running GNU Make with the build target:

    make build  
  

B. Standard Doxyfile - Command Line: Open a terminal into the root directory and generate the standard Doxyfile:

doxygen -g Doxyfile

⚙️ Configuration

To configure the C_Linux project you can:

1. Modify Doxygen's options by:

A. Doxygen: Changing/Adding manually a row in ./doxygen.ini before run it again, like:

<code>
  DOXY_PARAMETER = "DOXY_PARAMETER-VALUE"  
</code>

B. Doxyfile: Access the Doxyfile, generated by doxygen.sh script or run the

 doxygen -g Doxyfile

command, then change Doxygen's parameters manually.

2. Modify the default Makefile and make toolchain to customize and integrate your building behaviour.

3. You can change the default Markdown .md files to customize your project markdown documentation. The default Markdown project of C_Linux is structured as follow:

🚀 Run

Once the Doxyfile is generated and configured as you wish, to make the documentation use:

A. Doxygen Open a terminal into the root directory and run the doxygen installed tool with your Doxyfile;

    doxygen Doxyfile  
  

B. GNU Make: Open a terminal into the root directory and run the gnu make installed tool with your Makefile and doxygen.sh:

    make doc  
  

✅ Now you can find the documentation into ./docs/ or at your Doxyfile OUTPUT_DIRECTORY path.

❌ Uninstall

To uninstall the project just clean the documentation directory .e/docs/ and your Doxyfile or use the GNU Make tool and run the following command:

 make clean 

Licenses 📜

Table of Contents

This project is licensed under the Creative Commons Attribution 4.0 International License (CC BY 4.0) .

You are free to use, modify, and share this template — just give proper credit to Giuseppe Pedone.

© 2025 Giuseppe Pedone — GitHub: Unix69

Contributing 👋

Thank you for your interest in C_Linux!
You can freely download and use the C examples. To contribute, report bugs, or suggest improvements, follow the workflow below.

---

General Contribution Guidelines

• Read the CODE_OF_CONDUCT.md
• Understand the project structure
• Ensure required tools are installed: GCC, Make, Doxygen

When contributing code:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/your-feature)
3. Make changes and commit with clear messages (git commit -m "Add feature X")
4. Push your branch to GitHub
5. Open a Pull Request (PR)

Keep style consistent, update documentation, and run tests.

---

Authors 🧑‍💻

Giuseppe Pedone (Unix69)
Roles: FO, CEO
Contributions: `FI`, `OP`, `DE`
Email: giuseppe.pedone.developer@gmail.com
Links: GitHub

---

Contact ☎️

For questions or support:

• Open a GitHub Issue describing the problem
• Email the author for direct questions
• Check Documentation for reference

Issues are preferred to track bugs or feature requests efficiently.

---

Official Links 🌐

• GNU C Compiler (GCC) – Compiler for C projects
• C Programming Language – Language reference
• Linux OS – Target OS for examples
• POSIX – Standard APIs
• GNU Make – Build automation
• Doxygen – Documentation generator

---

FAQ ❓

Q1: Which C standard is used?
A1: All examples are written in C99.

Q2: Supported OS?
A2: POSIX-compliant systems, mainly Linux.

Q3: Can I modify and redistribute examples?
A3: Yes! All code is under GNU GPL v3.

Q4: How to compile an example?
A4: Use gcc or run make in project root.

Q5: How to report a bug?
A5: Open a GitHub Issue describing the error, affected example, and steps to reproduce.

---

Forking & Pull Requests 🔀

Fork the Project

1. Go to the main repository on GitHub
2. Click Fork to create your personal copy
3. Create a branch dedicated to your feature: git checkout -b feature-new-functionality
4. Keep it synchronized with the main project

Pull Requests (PR)

1. Ensure your branch is updated with the main branch
2. Confirm all tests and checks pass
3. Open a PR with:
   • Clear title (e.g., "Fix: memory leak in example")
   • Summary of changes
   • Related issue numbers (if any)
4. Wait for maintainers review
5. Apply requested changes and update PR if needed

PR Guidelines

• Use concise and descriptive titles
• Include examples or references if relevant
• Avoid committing unrelated files

---

Issues ⚠️

• Issues are for reporting bugs, requesting features, or asking questions
• Use the Issue Template if available
• Clearly describe:
  • Issue type: bug / feature / question
  • Steps to reproduce
  • Expected vs actual behavior
  • Environment: OS, version, configuration

All issues are tracked in the Issues section on GitHub.

---

Thanks 🙏

Special thanks to the Open Source Community for providing tools and frameworks such as GCC, Linux, GNU Make, and Doxygen.
Your work empowers projects like C_Linux to exist and evolve.