recls

recursive ls

Table of Contents

• Introduction
• Installation
• Components
  • C API / core library
  • C++ API
• Examples
• Project Information
  • Where to get help
  • Contribution guidelines
  • Dependencies
  • Related projects
  • License

Introduction

recls - recursive ls - is a platform-independent recursive file-system search library implemented in C and C++ with a C-API, and a C++ binding.

recls is completely free and includes source released under a BSD-style license.

Installation

Detailed instructions — via CMake — are provided in the accompanying INSTALL.md file.

Components

C API / core library

The recls C API provides recursive (and non-recursive) file-system search, stat-like entry queries, path utilities, and related helpers via recls/recls.h.

C++ API

The recls C++ API is a header-only binding over the core library, via recls/recls.hpp and the headers under recls/cpp/.

Examples

Examples are provided in the examples directory, along with a markdown description for each. A detailed list TOC of them is provided in EXAMPLES.md.

Project Information

Where to get help

GitHub Page

Contribution guidelines

Defect reports, feature requests, and pull requests are welcome on https://github.com/synesissoftware/recls.

If you'd like to help out with the project, please raise an issue via GitHub Page - you'll be very welcome!

Dependencies

STLSoft

recls depends on the STLSoft libraries, version 1.11.1-rc8 (or later).

• STLSoft;

Development Dependencies (optional for examples)

• 2be (example_cpp_4 smoke — skipped when absent or with --no-2be);

Development Dependencies (required for testing)

• xTests;
• b64 (optional; often via Pantheios);
• Diagnosticism (optional; version-string formatting in test.scratch.versions);
• Pantheios (optional);
• shwild (optional);
• UNIXem (optional; Windows UNIX-emulation builds);

Related projects

Projects in which recls is used include:

• libCLImate

License

recls is released under the 3-clause BSD license. See LICENSE for details.