From 21ea68ce16d0d7e0b7ea5bc0c688e3e0a2c9a357 Mon Sep 17 00:00:00 2001 From: Felipe Barriga Richards Date: Thu, 16 Feb 2017 12:10:39 -0300 Subject: [PATCH] man page: improve it and install it. --- CMakeLists.txt | 12 +++++++++++- ChangeLog | 1 + fuse_xattrs.1.in | 11 ++++++++--- 3 files changed, 20 insertions(+), 4 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 2fcfc96..9f2d870 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,4 +1,4 @@ -cmake_minimum_required(VERSION 2.8) +cmake_minimum_required(VERSION 2.8 FATAL_ERROR) project(fuse_xattrs C) set(FUSE_XATTRS_VERSION_MAJOR 0) @@ -19,6 +19,11 @@ include_directories( "${PROJECT_BINARY_DIR}" ) +configure_file ( + "${PROJECT_SOURCE_DIR}/fuse_xattrs.1.in" + "${PROJECT_BINARY_DIR}/fuse_xattrs.1" +) + # Check xattr headers include (CheckIncludeFile) check_include_file (sys/xattr.h HAVE_SYS_XATTR_H) @@ -67,6 +72,11 @@ target_link_libraries ( ) install (TARGETS fuse_xattrs DESTINATION bin) +install ( + FILES ${CMAKE_CURRENT_BINARY_DIR}/fuse_xattrs.1 + DESTINATION man/man1 + COMPONENT doc +) enable_testing() configure_file(run_tests.sh run_tests.sh COPYONLY) diff --git a/ChangeLog b/ChangeLog index 5282cad..a67fcb0 100644 --- a/ChangeLog +++ b/ChangeLog @@ -4,6 +4,7 @@ Release 0.2 (2017-02-16) * Fix tests * Added support to specify source directory (not mirroring the full fs /) * Hide sidecar files by default +* Added man page Release 0.1 (2016-10-23) ------------------------ diff --git a/fuse_xattrs.1.in b/fuse_xattrs.1.in index 67e3649..317d8b6 100644 --- a/fuse_xattrs.1.in +++ b/fuse_xattrs.1.in @@ -1,17 +1,22 @@ -.TH FUSE_XATTRS "1" "February 2017" "FUSE_XATTRS version 0.2" "User Commands" +.TH FUSE_XATTRS "1" "February 2017" "FUSE_XATTRS version @FUSE_XATTRS_VERSION_MAJOR@.@FUSE_XATTRS_VERSION_MINOR@" "User Commands" .SH NAME -FUSE_XATTRS \- Add xattrs support using sidecar files +FUSE_XATTRS \- Filesystem that add xattrs support using sidecar files .SH SYNOPSIS .SS mounting .TP \fBfuse_xattrs\fP \fBsource_dir\fP \fBmountpoint\fP .SS unmounting .TP -\fB__UNMOUNT_COMMAND__ mountpoint\fP +\fBfusermount -u mountpoint\fP .SH DESCRIPTION FUSE_XATTRS is a way to add xattrs support to any filesystem. The attributes are stored in sidecar files. .PP .PD +.SH "EXAMPLES" +.TP +Add xattrs support to \fB/mnt/nfs/data\fP by mounting it on \fB/mnt/nfs_data_with_xattrs\fP +\fBfuse_xattrs /mnt/nfs/data /mnt/nfs_data_with_xattrs\fP +.LP .SH "AUTHORS" .LP FUSE_XATTRS has been written by Felipe Barriga Richards . -- 2.39.2