lcheck

lcheck is a command-line tool that allows you to check for broken URLs and unresolved attributes.

Installation

1. Clone the repository.

2. Navigate to the lcheck directory:

   $ cd lcheck

3. Run the install.sh script:

   $ sh install.sh

4. Run lcheck command to check if installation was successful:

   $ lcheck

   Troubleshooting

   If you are getting the bash: lcheck: command not found…​ error, restart your terminal or source your ~/.bashrc file:

   source ~/.bashrc

Usage

• To see available command-line options, run:

  lcheck -h

• To for check broken links, run:

  $ lcheck -l <PATH>

  Replace <PATH> with a path to the file. The path can be a valid directory or master.adoc file.

  Example

  To check all master.adoc files in the rhel-8 directory, run:

  $ lcheck -l rhel-8/

  To check a specific master.adoc, run:

  $ lcheck -l rhel-8/titles/configuring-and-maintaining/configuring-basic-system-settings/master.adoc

• To check for unresolved attributes, run:

  $ lcheck -a <PATH>

  Replace <PATH> with a path to the master.adoc file or directory.

  Example

  To check all master.adoc files in the rhel-8 directory, run:

  $ lcheck -a rhel-8/

  To check a specific master.adoc, run:

  $ lcheck -a rhel-8/titles/configuring-and-maintaining/configuring-basic-system-settings/master.adoc

• To check if your document contains links to the wrong RHEL version, run:

  $ lcheck -c <VERSION> <PATH>

  Replace <VERSION> with the correct version number. Replace <PATH> with a path to the master.adoc file or directory.

  Example

  To check if all master.adoc files in the rhel-8 directory have red_hat_enterprise_linux/8 in the link pattern, run:

  $ lcheck -c 8 rhel-8/

  To check a specific master.adoc, run:

  $ lcheck -c 8 rhel-8/titles/configuring-and-maintaining/configuring-basic-system-settings/master.adoc

• To remove the master.html files left after the build process, run:

  $ lcheck -r <PATH>

  Replace <PATH> with a path to the master.adoc file or directory.