Whamcloud - gitweb
LU-4315 doc: add separate lctl-list_param man page
[fs/lustre-release.git] / lustre / doc / Makefile.am
index 442882d..8fa2f10 100644 (file)
 #
 # You should have received a copy of the GNU General Public License
 # version 2 along with this program; If not, see
-# http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
-#
-# Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
-# CA 95054 USA or visit www.sun.com if you need additional information or
-# have any questions.
+# http://www.gnu.org/licenses/gpl-2.0.html
 #
 # GPL HEADER END
 #
 
 #
-# Copyright  2008 Sun Microsystems, Inc. All rights reserved
+# Copyright (c) 2001, 2010, Oracle and/or its affiliates. All rights reserved.
 # Use is subject to license terms.
 #
+# Copyright (c) 2011, 2017, Intel Corporation.
+#
 
 #
 # This file is part of Lustre, http://www.lustre.org/
 # Lustre is a trademark of Sun Microsystems, Inc.
 #
 
-LYX2PDF = GS_OPTIONS=-dCompatibilityLevel=1.1 $(srcdir)/tex2pdf -overwrite
-TEX2PDF = GS_OPTIONS=-dCompatibilityLevel=1.1 $(srcdir)/tex2pdf -overwrite
-LYX2PS = lyx --export ps
-LYX2TEX = lyx --export latex
-LYX2TXT = lyx --export text
-LYX2HTML = lyx --export html
-LATEX = latex
-DVIPS = dvips
-PS2PDF = ps2pdf
-TEXEXPAND = texexpand
-SUFFIXES = .lin .lyx .pdf .ps .sgml .html .txt .tex .fig .eps .dvi
-
-MANFILES = lustre.7 lfs.1 mount.lustre.8 mkfs.lustre.8 tunefs.lustre.8 lctl.8 \
-       llverdev.8 llbackup.8 llapi_quotactl.3 llobdstat.8 llstat.8 \
-       plot-llstat.8 l_getgroups.8 lst.8 routerstat.8 lshowmount.8 \
-       ll_recover_lost_found_objs.8 llog_reader.8 llapi_file_open.3 \
-       llapi_file_create.3 llapi_file_get_stripe.3 liblustreapi.7
+MANFILES =                                     \
+       lctl.8                                  \
+       lctl-get_param.8                        \
+       lctl-list_param.8                       \
+       lctl-network.8                          \
+       lctl-set_param.8                        \
+       ldev.8                                  \
+       ldev.conf.5                             \
+       lfs.1                                   \
+       lfs-df.1                                \
+       lfs-fid2path.1                          \
+       lfs-find.1                              \
+       lfs-getstripe.1                         \
+       lfs-getdirstripe.1                      \
+       lfs-heat.1                              \
+       lfs-hsm.1                               \
+       lfs-ladvise.1                           \
+       lfs_migrate.1                           \
+       lfs-migrate.1                           \
+       lfs-mirror-create.1                     \
+       lfs-mirror-extend.1                     \
+       lfs-mirror-resync.1                     \
+       lfs-mirror-split.1                      \
+       lfs-mirror-verify.1                     \
+       lfs-mkdir.1                             \
+       lfs-path2fid.1                          \
+       lfs-pcc.1                               \
+       lfs-project.1                           \
+       lfs-setdirstripe.1                      \
+       lfs-setstripe.1                         \
+       lfs-setquota.1                          \
+       l_getidentity.8                         \
+       lgss_sk.8                               \
+       lhbadm.8                                \
+       llapi_create_volatile_param.3           \
+       llapi_fd2parent.3                       \
+       llapi_file_create.3                     \
+       llapi_file_create_foreign.3             \
+       llapi_file_get_stripe.3                 \
+       llapi_file_open.3                       \
+       llapi_group_lock.3                      \
+       llapi_group_unlock.3                    \
+       llapi_heat_get.3                        \
+       llapi_heat_set.3                        \
+       llapi_hsm_action_begin.3                \
+       llapi_hsm_action_end.3                  \
+       llapi_hsm_action_get_dfid.3             \
+       llapi_hsm_action_get_fd.3               \
+       llapi_hsm_action_progress.3             \
+       llapi_hsm_copytool_get_fd.3             \
+       llapi_hsm_copytool_recv.3               \
+       llapi_hsm_copytool_register.3           \
+       llapi_hsm_copytool_unregister.3         \
+       llapi_hsm_state_get.3                   \
+       llapi_hsm_state_set.3                   \
+       llapi_ladvise.3                         \
+       llapi_layout.7                          \
+       llapi_layout_alloc.3                    \
+       llapi_layout_comp_add.3                 \
+       llapi_layout_comp_del.3                 \
+       llapi_layout_comp_extent_get.3          \
+       llapi_layout_comp_extent_set.3          \
+       llapi_layout_comp_flags_clear.3         \
+       llapi_layout_comp_flags_get.3           \
+       llapi_layout_comp_flags_set.3           \
+       llapi_layout_comp_id_get.3              \
+       llapi_layout_comp_use.3                 \
+       llapi_layout_comp_use_id.3              \
+       llapi_layout_file_comp_add.3            \
+       llapi_layout_file_comp_del.3            \
+       llapi_layout_file_create.3              \
+       llapi_layout_file_open.3                \
+       llapi_layout_free.3                     \
+       llapi_layout_get_by_fd.3                \
+       llapi_layout_get_by_fid.3               \
+       llapi_layout_get_by_path.3              \
+       llapi_layout_get_by_xattr.3             \
+       llapi_layout_ost_index_get.3            \
+       llapi_layout_ost_index_set.3            \
+       llapi_layout_pattern_get.3              \
+       llapi_layout_pattern_set.3              \
+       llapi_layout_pool_name_get.3            \
+       llapi_layout_pool_name_set.3            \
+       llapi_layout_stripe_count_get.3         \
+       llapi_layout_stripe_count_set.3         \
+       llapi_layout_stripe_size_get.3          \
+       llapi_layout_stripe_size_set.3          \
+       llapi_path2fid.3                        \
+       llapi_path2parent.3                     \
+       llapi_quotactl.3                        \
+       ll_decode_linkea.8                      \
+       llobdstat.8                             \
+       llog_reader.8                           \
+       llsom_sync.8                            \
+       llstat.8                                \
+       lnetctl.8                               \
+       lst.8                                   \
+       lustre.7                                \
+       lustreapi.7                             \
+       lustre_routes_config.8                  \
+       lustre_routes_conversion.8              \
+       lustre_rsync.8                          \
+       mount.lustre.8                          \
+       mount.lustre_tgt.8                      \
+       nids.5                                  \
+       plot-llstat.8                           \
+       routerstat.8
+
+SERVER_MANFILES =                              \
+       lctl-barrier.8                          \
+       lctl-lcfg.8                             \
+       lctl-lfsck-query.8                      \
+       lctl-lfsck-start.8                      \
+       lctl-lfsck-stop.8                       \
+       lctl-llog_cancel.8                      \
+       lctl-llog_catlist.8                     \
+       lctl-llog_info.8                        \
+       lctl-llog_print.8                       \
+       lctl-nodemap-activate.8                 \
+       lctl-nodemap-add.8                      \
+       lctl-nodemap-add-idmap.8                \
+       lctl-nodemap-add-range.8                \
+       lctl-nodemap-del.8                      \
+       lctl-nodemap-del-idmap.8                \
+       lctl-nodemap-del-range.8                \
+       lctl-nodemap-modify.8                   \
+       lctl-nodemap-set-fileset.8              \
+       lctl-nodemap-set-sepol.8                \
+       lctl-snapshot-create.8                  \
+       lctl-snapshot-destroy.8                 \
+       lctl-snapshot-list.8                    \
+       lctl-snapshot-modify.8                  \
+       lctl-snapshot-mount.8                   \
+       lctl-snapshot-umount.8                  \
+       ll_decode_filter_fid.8                  \
+       llverdev.8                              \
+       lshowmount.8                            \
+       mkfs.lustre.8                           \
+       tunefs.lustre.8
+
+if SERVER
+MANFILES += $(SERVER_MANFILES)
+else
+DISTONLY_MANFILES = $(SERVER_MANFILES)
+endif
 
 if UTILS
+if MANPAGES
 man_MANS = $(MANFILES)
 endif
-
-LYXFILES= $(filter-out $(patsubst %.lin,%.lyx,$(wildcard *.lin)),\
-       $(wildcard *.lin *.lyx))
+endif
 
 CLEANFILES = *.aux *.tex *.log *.pdf
 
-EXTRA_DIST = tex2pdf $(MANFILES) $(LYXFILES)
+EXTRA_DIST = $(MANFILES) $(DISTONLY_MANFILES)
 
 all:
-
-# These variables are set by lbuild/check-build.
-RPMRELEASE ?= RELEASE
-KERNTYPE ?= chaos
-KERNRPM ?= kernel-2.4.18lustre13-RELEASE.i386.rpm
-
-.lyx.pdf:
-       @echo $(LYX2PDF) $< && $(LYX2PDF) $< || printf "\n*** Warning: not creating PDF docs; install lyx to rectify this\n"
-
-.lyx.ps:
-       @echo $(LYX2PS) $< && $(LYX2PS) $< || printf "\n*** Warning: not creating PostScript docs; install lyx to rectify this\n"
-
-.lyx.tex:
-       @echo $(LYX2TEX) $< && $(LYX2TEX) $< || printf "\n*** Warning: not creating LaTeX docs; install lyx to rectify this\n"
-
-.lyx.txt:
-       @echo $(LYX2TXT) $< && $(LYX2TXT) $< || printf "\n*** Warning: not creating text docs; install lyx to rectify this\n"
-
-.lyx.html:
-       @echo $(LYX2HTML) $< && $(LYX2HTML) $< || printf "\n*** Warning: not creating HTML docs; install lyx to rectify this\n"
-
-.tex.pdf:
-       $(TEX2PDF) $<
-
-.tex.dvi:
-       $(LATEX) $<
-       $(LATEX) $<
-
-.dvi.ps:
-       $(DVIPS) $< -o $@
-
-.ps.pdf:
-       $(PS2PDF) $< $@